OpenSCADAWiki: Home Page En/Doc/VC Aconcept/part4/part12 ...

Primitive is the basis for drawing basic graphic shapes with their possible combinations in a single object. The support of the following basic figures is provided:

• Line.
• Arc.
• Bézier curve.
• Fill of the enclosed space.

For all the figures contained in the widget it is set the common properties of thickness, color, etc., but this does not exclude the possibility of indicating the above attributes for each figure separately.

Includes support for standard form components:

• Line edit.
• Text edit.
• Check box.
• Button.
• Combo box.
• List.
• Tree.
• Table.
• Slider.
• Scroll bar.

Permission to the widget in form "{user}{group}{other}" plus inheritance flag, includes the inheritance owner and it's permissions from upper widget.
Where "user", "group" and "other" is:

• "__" — no any access;
• "R_" — read-only;
• "RW" — read and write.

By default the 01000(inheritance).

Context menu in form strings list: "{ItName}:{Signal}".
Where:

• "ItName" — the item name;
• "Signal" — the signal name, for it forming as "usr_{Signal}".

Attribute for storing of the script of the processing of event of direct control of user interface. Script is the list of commands to the visualization interface generated at the event receipt (attribute event). Direct events processing for pages manipulation in form: "{event}:{evSrc}:{com}:{prm}". Where:

• "event" — the waiting event;
• "evSrc" — the event source;
• "com" — the command of a session (open, next, prev);
• "prm" — the command parameter, where used:
  • pg_so — direct name of the desired page with the prefix;
  • 1 — name of a new page in a general way, without a prefix;
  • * — the page is taken from the name of a previous page;
  • $ — points the place of the opened page relative.

Examples:

• ws_BtPress:/prev:prev:/pg_so/*/*/$
• ws_BtPress:/next:next:/pg_so/*/*/$
• ws_BtPress:/go_mn:open:/pg_so/*/mn/*
• ws_BtPress:/go_graph:open:/pg_so/*/ggraph

Color name form "{color}[-{alpha}]", where:

• "color" — standard color name or digital view of three hexadecimal digit's number form "#RRGGBB";
• "alpha" — alpha channel level [0...255], where 0 — complete transparent.

Examples:

• "red" — solid red color;
• "#FF0000" — solid red color by digital code;
• "red-127" — half transparent red color.

Image name in form "[{src}:]{name}", where:

• "src" — the image source:
  • file — direct from local file by the path;
  • res — from the DB mime resources table.
• "name" — the file path or the resource mime Id.

Examples:

• "res:backLogo" — from the DB mime resources table for id "backLogo";
• "backLogo" — like previous;
• "file:/var/tmp/backLogo.png" — from local file by the path "/var/tmp/backLogo.png".

List of graphic primitives in the following format:

• Line. Record form in the list, for static and dynamic parameters (may mix):
  "line:({x}|{y}):({x}|{y})[:{width}[:{color}[:{bord_w}[:{bord_clr}[:{line_stl}]]]]]"
  "line:{p1}:{p2}[:w{n}[:c{n}[:w{n}[:c{n}[:s{n}]]]]]"
  
• Arc. Record form in the list, for static and dynamic parameters (may mix):
  "arc:({x}|{y}):({x}|{y}):({x}|{y}):({x}|{y}):({x}|{y})[:{width}[:{color}[:{bord_w}[:{bord_clr}[:{line_stl}]]]]]"
  "arc:{p1}:{p2}:{p3}:{p4}:{p5}[:w{n}[:c{n}[:w{n}[:c{n}[:s{n}]]]]]"
  
  
  p1, p2 — starting and ending points of an elliptic arc, respectively;
  p3 — the center of the arc;
  p4 — first radius;
  p5 — second radius.
  
• Bézier curve. Record form in the list, for static and dynamic parameters (may mix):
  "bezier:({x}|{y}):({x}|{y}):({x}|{y}):({x}|{y})[:{width}[:{color}[:{bord_w}[:{bord_clr}[:{line_stl}]]]]]"
  "bezier:{p1}:{p2}:{p3}:{p4}[:w{n}[:c{n}[:w{n}[:c{n}[:s{n}]]]]]"
  
• Fill. Record form in the list:
  "fill:({x}|{y}):({x}|{y}):...:({x}|{y})[:{fill_clr}[:{fill_img}]]"
  "fill:{p1}:{p2}:...:{pN}[:c{n}[:i{n}]]"

Where:

For example:

• line:(50|25):(90.5|25):2:yellow:3:green:2
• arc:(25|50):(25|50):1:4:(25|50)::#000000-0
• fill:(25|50):(25|50):c2:i2
• fill:(50|25):(90.5|25):(90|50):(50|50):#d3d3d3:h_31

Configuration of the line. The format of the value of the field for different types of lines:

Font name form "{family} {size} {bold} {italic} {underline} {strike}", where:

• "family" — font family, for spaces use symbol '_', like: "Arial", "Courier", "Times_New_Roman";
• "size" — font size in pixels;
• "bold" — font bold (0 or 1);
• "italic" — font italic (0 or 1);
• "underline" — font underlined (0 or 1);
• "strike" — font struck (0 or 1).

Examples:

• "Arial 10 1 0 0 0" — Arial font size 10 pixels and bold.

The value, different for modes:

• "Standard" — repeating parameters of events on holding "{delay}-{interval}", time in milliseconds;
• "Checkable" — toggle value;
• "Menu" — addresses of menu elements list like "/grp1/grp2/item1";
• "Load" — description line "{FilesTemplate}|{Header}|{FileByDefault}" and loaded file content. Files template like "Images (*.png *.xpm *.jpg);;CSV-file (*.csv)".
• "Save" — description line "{FilesTemplate}|{Header}|{FileByDefault}" and saved file content. Files template like before.

The image on the button. Image name in form "[{src}:]{name}", where:

• "src" — the image source:
  • file — direct from local file by the path;
  • res — from the DB mime resources table.
• "name" — the file path or the resource mime Id.

Examples:

• "res:backLogo" — from the DB mime resources table for Id "backLogo";
• "backLogo" — like previous;
• "file:/var/tmp/backLogo.png" — from local file by the path "/var/tmp/backLogo.png".

Color of the button. Color name form "{color}[-{alpha}]", where:

• "color" — the standard color name or digital view of three hexadecimal digit's number form "#RRGGBB";
• "alpha" — the alpha channel level [0...255].

Examples:

• "red" — solid red color;
• "#FF0000" — solid red color by the digital code;
• "red-127" — half transparent red color.

The button operation mode:

• "Standard" — normal button which allow events repeat on it hold (the parameters into "value");
• "Checkable" — fixed button (values into "value");
• "Menu" — open menu on press (items list into "value");
• "Load" — provides user-space small files loading through the visual interface; on the mode the button press will open selection file dialog for loading and the file content next saving to the attribute "value";
• "Save" — provides user-space small files saving through the visual interface; on the file content writing to "value" attribute for user will open selection/set file dialog and next saving the attribute "value" content to the file and next the attribute "value" will set clean.

Address of the selected item. It changing follows by the signal "ws_TableChangeSel". The address format depends from the table's selection mode:

• "Cell" — the cell address in format "{row}:{col}".
• "Row", "Column" — the row-column number or the row-column key's cell content, which sets by the attribute "keyID".

The table structure and content in XML view:

The tags:

Configuration of the slider in the format: "{VertOrient}:{Min}:{Max}:{SinglStep}:{PageStep}".
Where:

• "VertOrient" — sign (0 or 1) of a vertical orientation, the default is the horizontal orientation;
• "Min" — minimum value;
• "Max" — maximum value;
• "SinglStep" — the size of a single step;
• "PageStep" — the size of a page step.

Background color. Color name in form "{color}[-{alpha}]", where:

• "color" — standard color name or digital view of three hexadecimal digit's number form "#RRGGBB";
• "alpha" — alpha channel level [0...255], where 0 - is full transparent.

Examples:

• "red" — solid red color;
• "#FF0000" — solid red color by the digital code;
• "red-127" — half transparent red color.

Background image. The image name in form "[{src}:]{name}", where:

• "src" — the image source:
  • file — direct from local file by the path;
  • res — from the DB mime resources table.
• "name" — the file path or the resource mime Id.

Examples:

• "res:backLogo" — from DB mime resources table for Id "backLogo";
• "backLogo" — like previous;
• "file:/var/tmp/backLogo.png" — from local file by the path "/var/tmp/backLogo.png".

Font name form "{family} {size} {bold} {italic} {underline} {strike}", where:

• "family" — font family, for spaces use symbol '_', like: "Arial", "Courier", "Times_New_Roman";
• "size" — font size in pixels;
• "bold" — font bold (0 or 1);
• "italic" — font italic (0 or 1);
• "underline" — font underlined (0 or 1);
• "strike" — font struck (0 or 1).

Examples:

• "Arial 10 1 0 0 0" — Arial font size 10 pixels and bold.

Argument x configuration:

• "String": {len} — string length;
• "Real": {wdth};{form};{prec} — value width, the form of ('g', 'e', 'f') and the precision;
• "Integer": {len} — value length.

Background color. Color name in form "{color}[-{alpha}]", where:

• "color" — standard color name or digital view of three hexadecimal digit's number form "#RRGGBB";
• "alpha" — alpha channel level [0...255], where 0 - is full transparent.

Examples:

• "red" — solid red color;
• "#FF0000" — solid red color by the digital code;
• "red-127" — half transparent red color.

Background image. The image name in form "[{src}:]{name}", where:

• "src" — the image source:
  • file — direct from local file by the path;
  • res — from the DB mime resources table.
• "name" — the file path or the resource mime Id.

Examples:

• "res:backLogo" — from DB mime resources table for Id "backLogo";
• "backLogo" — like previous;
• "file:/var/tmp/backLogo.png" — from local file by the path "/var/tmp/backLogo.png".

Media source name in form "[{src}:]{name}", where:

• "src" — source:
  • file — direct from local (visualizer or engine) file by the path;
  • res — from the DB mime resources table;
  • stream — Stream URL for the video and the audio play.
• "name" — the file path or the resource mime Id.

Examples:

• "res:workMedia" — from DB mime resources table for Id "workMedia";
• "workMedia" — like previous;
• "file:/var/tmp/workMedia.mng" — from local file by path "/var/tmp/workMedia.mng";
• "stream:http://localhost.localhost:5050" — video and audio stream play from URL.

Media type variant:

• "Image" — raster or vector(can not support) image, like: PNG, JPEG, GIF, SVG;
• "Animation" — simple animation image, like: GIF, MNG;
• "Full video" — full video, audio or stream, like: OGG, OGM, AVI, MKV, MPG, MP3, MP4.

Background color. Color name in form "{color}[-{alpha}]", where:

• "color" — standard color name or digital view of three hexadecimal digit's number form "#RRGGBB";
• "alpha" — alpha channel level [0...255], where 0 - is full transparent.

Examples:

• "red" — solid red color;
• "#FF0000" — solid red color by the digital code;
• "red-127" — half transparent red color.

Background image. The image name in form "[{src}:]{name}", where:

• "src" — the image source:
  • file — direct from local file by the path;
  • res — from the DB mime resources table.
• "name" — the file path or the resource mime Id.

Examples:

• "res:backLogo" — from DB mime resources table for Id "backLogo";
• "backLogo" — like previous;
• "file:/var/tmp/backLogo.png" — from local file by the path "/var/tmp/backLogo.png".

Font of the markers of scale/grid. Font name form "{family} {size} {bold} {italic} {underline} {strike}", where:

• "family" — font family, for spaces use symbol '_', like: "Arial", "Courier", "Times_New_Roman";
• "size" — font size in pixels;
• "bold" — font bold (0 or 1);
• "italic" — font italic (0 or 1);
• "underline" — font underlined (0 or 1);
• "strike" — font struck (0 or 1).

Examples:

• "Arial 10 1 0 0 0" — Arial font size 10 pixels and bold.

Full address to DAQ attribute of a parameter X or to an archive.
Also supported direct data set by the prefixes:

• "data:{XMLNodeData}" — drawing from the direct set data;
• "line:{value}" — drawing the horizontal line by the value, no sense have for type "XY".

Example:

• "/DAQ/System/AutoDA/MemInfo/use" — address to attribute "use" of parameter "MemInfo" of controller "AutoDA" of DAQ module "System";
• "/Archive/va_CPULoad_load" — address to archive "CPULoad_load".
• "data:<d s="1" aprox="1" tm="1369465209" tm_grnd="1369465200" per="1">

• "line:3.14159265" — horizontal line into value "3.14159265".

Background color. Color name in form "{color}[-{alpha}]", where:

• "color" — standard color name or digital view of three hexadecimal digit's number form "#RRGGBB";
• "alpha" — alpha channel level [0...255], where 0 - is full transparent.

Examples:

• "red" — solid red color;
• "#FF0000" — solid red color by the digital code;
• "red-127" — half transparent red color.

Background image. The image name in form "[{src}:]{name}", where:

• "src" — the image source:
  • file — direct from local file by the path;
  • res — from the DB mime resources table.
• "name" — the file path or the resource mime Id.

Examples:

• "res:backLogo" — from DB mime resources table for Id "backLogo";
• "backLogo" — like previous;
• "file:/var/tmp/backLogo.png" — from local file by the path "/var/tmp/backLogo.png".

Font of markers of scale/grid. Font name form "{family} {size} {bold} {italic} {underline} {strike}", where:

• "family" — font family, for spaces use symbol '_', like: "Arial", "Courier", "Times_New_Roman";
• "size" — font size in pixels;
• "bold" — font bold (0 or 1);
• "italic" — font italic (0 or 1);
• "underline" — font underlined (0 or 1);
• "strike" — font struck (0 or 1).

Examples:

• "Arial 10 1 0 0 0" — Arial font size 10 pixels and bold.

Category template or regular expression "/{re}/". For template reserved special symbols:

• '*' — any multiply symbols group;
• '?' — any one symbol;
• '\\' — use for shield special symbols.

Visible and order columns list separated by symbol ';'. Supported columns:

• "pos" — row number;
• "tm" — date and time of the message;
• "utm" — microseconds part of the time of the message;
• "lev" — level of the message;
• "cat" — category of the message;
• "mess" — the message text.

Basic font of the text. Font name form "{family} {size} {bold} {italic} {underline} {strike}", where:

• "family" — font family, for spaces use symbol '_', like: "Arial", "Courier", "Times_New_Roman";
• "size" — font size in pixels;
• "bold" — font bold (0 or 1);
• "italic" — font italic (0 or 1);
• "underline" — font underlined (0 or 1);
• "strike" — font struck (0 or 1).

Examples:

• "Arial 10 1 0 0 0" — Arial font size 10 pixels and bold.

Background color. Color name in form "{color}[-{alpha}]", where:

• "color" — standard color name or digital view of three hexadecimal digit's number form "#RRGGBB";
• "alpha" — alpha channel level [0...255], where 0 - is full transparent.

Examples:

• "red" — solid red color;
• "#FF0000" — solid red color by the digital code;
• "red-127" — half transparent red color.

Background image. The image name in form "[{src}:]{name}", where:

• "src" — the image source:
  • file — direct from local file by the path;
  • res — from the DB mime resources table.
• "name" — the file path or the resource mime Id.

Examples:

• "res:backLogo" — from DB mime resources table for Id "backLogo";
• "backLogo" — like previous;
• "file:/var/tmp/backLogo.png" — from local file by the path "/var/tmp/backLogo.png".