From OpenSCADAWiki
Jump to: navigation, search

1 Примитивы виджетов

Любой вновь создаваемый виджет основывается на одном из нескольких примитивов — конечном элементе визуализации, путём установки родственной связи как прямо на примитив, так и посредством нескольких промежуточных пользовательских виджетов. Каждый из примитивов содержит механизм модели данных. Экземпляр виджета хранит значения свойств собственной конфигурации примитива.

В задачи интерфейса визуализации входит поддержка и работа с моделью данных примитивов виджетов. Примитивы виджетов должны быть тщательно проработаны и унифицированы, с целью охватить как можно больше возможностей в как можно меньшем количестве слабо связанных друг с другом, по назначению, примитивов.

Таблица. Библиотека примитивов виджетов — базовые элементы отображения

Идентификатор Наименование Функция
ElFigure Элементарная графическая фигура

Примитив является основой отрисовки элементарных графических фигур со всевозможной комбинацией их в одном объекте. Предусматривается поддержка следующих элементарных фигур:

  • Линия.
  • Дуга.
  • Кривая Безье.
  • Заливка замкнутого пространства.

Для всех фигур, содержащихся в виджете, устанавливаются единые свойства толщины, цвета и т.д., также, предусматривается возможность указания вышеперечисленных атрибутов для каждой фигуры отдельно и их динамизация.

FormEl Элемент формы

Включает поддержку стандартных компонентов формы:

  • Редактирование строки.
  • Редактирование текста.
  • Флажок.
  • Кнопка.
  • Выбор из списка.
  • Список.
  • Дерево.
  • Таблица.
  • Слайдер.
  • Строка прокрутки.
Text Текст Элемент текста-метка. Характеризуется типом шрифта, цветом, ориентацией и выравниванием. Предусматривается поддержка аргументов.
Media Медиа Элемент отображения растровых и векторных изображений различных форматов, проигрывания анимированных изображений, проигрывание аудио-фрагментов и просмотр видео-фрагментов.
Diagram Диаграмма Элемент диаграммы с поддержкой возможности отображения нескольких потоков в реальном времени для: трендов (временных графиков), частотного спектра, XY диаграмм.
Protocol Протокол Элемент протокола — визуализатор сообщений программы, с поддержкой нескольких режимов работы.
Document Документ Элемент формирования отчётов, журналов и другой документации на основе доступных данных.
Box Контейнер Содержит механизм размещения-включения других виджетов для формирования новых, более сложных, виджетов и страниц конечной визуализации.
Function, в планах Функция API объектной модели OpenSCADA Невизуальный виджет, на стороне исполнения, позволяющий включать вычислительные функции объектной модели OpenSCADA в СВУ.

Таблица. Общий набор свойств/атрибутов виджета

Идентификатор Имя Номер Значение
id Идентификатор - Идентификатор элемента. Атрибут только для чтения, призванный предоставить информацию об идентификаторе элемента.
path Путь - Путь к этому виджету. Атрибут только для чтения и предоставления исчерпывающей информации о расположения элемента.
parent Родитель - Путь к родительскому виджету. Атрибут только для чтения и предоставления информации о расположении предка от которого унаследован виджет.
owner Владелец - Владелец и группы виджета, в виде "{владелец}:{группа[,группа2,группаN]}", по умолчанию "root:UI".
perm Доступ -

Права доступа к виджету, в виде "{пользователь}{группы}{другие}" плюс флаг наследования, включающий наследование владельца и его прав от вышестоящего виджета.
Где "пользователь", "группы" и "другие" это:

  • "__" — нет доступа;
  • "R_" — только чтение;
  • "RW" — чтение и запись.

По умолчанию 01000 — наследование.

root Корень 1 Идентификатор виджета-примитива (базового элемента), который лежит в основе образа визуализации виджета.
name Имя - Имя элемента. Модифицируемое имя элемента.
dscr Описание - Описание элемента. Текстовое поле краткого описания.
en Включен 5 Состояние "Включен" элемента. Отключенный элемент не отображается при исполнении.
active Активный 6 Состояние "Активный" элемента. Активный элемент может получать фокус при исполнении, а значит — получать клавиатурные и иные события с последующей их обработкой.
geomX Геометрия: x 7 Геометрия, координата 'x' положения элемента.
geomY Геометрия: y 8 Геометрия, координата 'y' положения элемента.
geomW Геометрия: ширина 9 Геометрия, ширина элемента.
geomH Геометрия: высота 10 Геометрия, высота элемента.
geomXsc Геометрия: x масштаб 13 Масштаб элемента по горизонтали.
geomYsc Геометрия: y масштаб 14 Масштаб элемента по вертикали.
geomZ Геометрия: z 11 Геометрия, координата 'z' (уровень) элемента на кадре. Также определяет порядок передачи фокуса между активными элементами.
geomMargin Геометрия: отступ 12 Геометрия, поля-отступы элемента.
tipTool Помощь: подсказка 15 Текст краткой помощи или подсказки по данному элементу. Обычно реализуется как всплывающая подсказка, при удержании курсора мыши над элементом.
tipStatus Помощь: состояние 16

Текст информации о состоянии элемента или руководства к действию над элементом. Обычно реализуется в виде сообщения в строке статуса, при удержании курсора мыши над элементом.

* Модификация данного атрибута из сеанса корневой страницы осуществляет запись сообщения в строку статуса окна визуализации сеанса.
contextMenu Контекстное меню 17

Контекстное меню в виде списка строк: "{ItName}:{Signal}".
Где:

  • "ItName" — имя элемента;
  • "Signal" — имя сигнала, формирующегося при выборе: "usr_{Signal}".
evProc Обработка событий -

Атрибут хранения сценария обработки событий непосредственного управления пользовательским интерфейсом. Сценарий представляет собой список команд интерфейсу визуализации, генерируемых при поступлении события (атрибут event). Прямая обработка событий для управления страницами в виде: "{event}:{evSrc}:{com}:{prm}". Где:

  • "event" — ожидаемое событие;
  • "evSrc" — источник события;
  • "com" — команда сеанса: open, next, prev;
  • "prm" — параметр команды, где используется:
    • pg_so — прямое имя желаемой страницы, с префиксом;
    • 1 — имя новой страницы в общем пути, без префикса;
    • * — имя страницы берётся из имени предыдущей страницы;
    • $ — указывает на место, относительно которого открывается страница.

Примеры:

  • 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
Дополнительные атрибуты элементов, помещённых в проект в роли страницы.
pgOpen Страница: открыта -

Признак "Страница открыта".

* Модификация из сеанса осуществляет немедленное открытие/закрытие данной страницы, но для страниц типа "Связь" Вы должны отдавать предпочтение использованию функции uiCmd() пользовательского API, для управления страницами.
pgNoOpenProc Страница: обрабатывать закрытой - Признак "Исполнять страницу даже если она закрыта".
pgOpenSrc Страница: источник открытия 3

Полный адрес страницы, открывшей данную.

* Запись/очистка адреса виджета (инициатора открытия), осуществляет немедленное открытие/закрытие страницы. В случае записи адреса, и выполнения других условий, осуществляется динамическое связывание текущего виджета с инициатором. Но для страниц типа "Связь" Вы должны отдавать предпочтение использованию функции uiCmd() пользовательского API, для управления страницами.
pgGrp Страница: группа 4 Группа страницы. ПУСТАЯ и "main" группа предусматривает использование этой страницы как Корневую-основную страницу, т.е. такая будет заменять другие Корневые-главные страницы; группа "fl" предназначена для использования во внешних окнах, которые предусмотрены для многоразового одновременного открытия и которые не должны отслеживаться на дубликаты; остальные предусмотрено для включения в контейнеры-боксы или одноразового одновременного открытия, т.е. они принудительно проверяются на дубликаты, когда последнее открывается, а предыдущие закрываются.
Дополнительные атрибуты режима исполнения — сеанса.
(Виртуальные атрибуты не доступны в процедуре виджета)
event События - Специальный атрибут сбора событий виджета в списке, разделённом новой строкой. Доступ к атрибуту защищён критической секцией для избежания потери событий. Атрибут всегда доступен в процедуре виджета.
load Загрузка -1 Виртуальная команда групповой загрузки данных.
focus Фокус -2 Специальный атрибут индикации факта получения фокуса, активным виджетом. Атрибут этого виджета и вложенных виджетов доступен в процедурах виджета.
perm Доступ -3 Виртуальный атрибут прав активного пользователя на просмотр и контроль над виджетом.
* — Специальная функция атрибута виджета, выполняемая в сеансе проекта при пользовательской модификации.

Движок среды визуализации предусматривает активацию атрибутов, специфичных для визуализатора. Процесс активации осуществляется при открытии сеанса визуализации проекта и предусматривает, в этом проекте: создание специфичного атрибута с указанными свойствами, если он отсутствует, и активацию отслеживания его модификации движком среды визуализации, как для атрибутов формирования образов примитивов. Для непосредственного определения такого атрибута можно также использовать префикс идентификатора атрибута "vs_", что быстрее и исключает стадию активации. С перечнем специфичных для визуализатора атрибутов можно ознакомиться в документации соответствующего визуализатора.

1.1 Элементарная графическая фигура (ElFigure)

Примитив является основой в отрисовке элементарных графических фигур со всевозможной их комбинацией в одном объекте. Учитывая широкий спектр всевозможных фигур, которые должен поддерживать примитив, и, в тоже время, являться достаточно простым в использовании и, по возможности, в реализации, было решено ограничить перечень базовых фигур, используемых для построения результирующих графических объектов, до таких: линия, дуга, кривая Безье и заливка замкнутых контуров. Основываясь уже на этих базовых фигурах, можно строить производные фигуры, комбинируя базовые. В рамках примитива существует возможность задания прозрачности цвета в диапазоне [0...255], где '0' — полная прозрачность.

Таблица. Набор дополнительных свойств/атрибутов примитива "Элементарная фигура (ElFigure)"

Идентификатор Имя Номер Значение
lineWdth Линия: ширина 20 Ширина линии.
lineClr Линия: цвет 21

Имя цвета в виде "{color}[-{alpha}]", где:

  • "color" — стандартное имя цвета или его числовое представление из трёх шестнадцатеричных чисел отдельных цветов "#RRGGBB";
  • "alpha" — уровень альфа-канала [0...255], где 0 — полностью прозрачный.

Примеры:

  • "red" — сплошной красный цвет;
  • "#FF0000" — сплошной красный цвет в цифровом коде;
  • "red-127" — полупрозрачный красный цвет.
lineStyle Линия: стиль 22 Стиль линии: сплошная, пунктир, точечная.
bordWdth Граница: ширина 23 Ширина бордюра линии. Нулевая ширина указывает на отсутствие бордюра.
bordClr Граница: цвет 24 Цвет бордюра (детали в атрибуте 21).
fillColor Заполнение: цвет 25 Цвет заливки (детали в атрибуте 21).
fillImg Заполнение: изображение 26

Имя изображения в виде "[{src}:]{name}", где:

  • "src" — источник изображения:
    • file — прямо из локального файла по пути;
    • res — из таблицы ресурсов БД.
  • "name" — путь файла или идентификатор ресурса.

Примеры:

  • "res:backLogo" — из таблицы ресурсов БД для идентификатора "backLogo";
  • "backLogo" — как и предыдущий;
  • "file:/var/tmp/backLogo.png" — из локального файла по пути "/var/tmp/backLogo.png".
orient Угол поворота 28 Угол поворота содержимого виджета.
mirror Отражение 29 Отражение содержимого виджета, ограничено на данный момент.
elLst Список элементов 27

Список графических элементов в формате:

  • Линия. Общая форма записи в списке, для статических и динамических параметров (могут смешиваться):
"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:({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}]]]]]"
VCA arc.png
p1, p2 — начальная и конечная точки эллиптической дуги, соответственно;
p3 — центр дуги;
p4 — первый радиус;
p5 — второй радиус.
  • Кривая Безье. Форма записи в списке, для статических и динамических параметров (могут смешиваться):
"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:({x}|{y}):({x}|{y}):...:({x}|{y})[:{fill_clr}[:{fill_img}]]"
"fill:{p1}:{p2}:...:{pN}[:c{n}[:i{n}]]"

Где:

x, y — прямая точка (x,y), координаты в пикселах с плавающей точкой;
p1 ... pN — динамическая точка 1...N;
width, bord_w — прямая ширина линии и бордюра в пикселах с плавающей точкой;
w{n} — динамическая ширина 'n';
color, bord_clr, fill_clr — прямой цвет линии, бордюра и заполнения, в виде имени или 32-битного кода с альфа: {имя}[-{AAA}], #RRGGBB-AAA;
c{n} — динамический цвет 'n';
line_stl — прямой стиль линии: 0-Сплошная, 1-Пунктирная, 2-Точечная;
s{n} — динамический стиль 'n';
fill_img — прямое изображение заполнения в виде "[{src}%3A]{name}", где:
"src" — источник изображения:
file — непосредственно из локального файла по пути;
res — из таблицы ресурсов БД.
"name" — путь файла или идентификатор ресурса.
i{n} — динамическое изображение заполнения 'n'.

Например:

  • 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
Атрибуты каждой точки из списка графических фигур elLst
p{n}x Точка {n}:x 30+n*6 Координата 'x' точки n.
p{n}y Точка {n}:y 30+n*6+1 Координата 'y' точки n.
w{n} Ширина {n} 30+n*6+2 Ширина n.
с{n} Цвет {n} 30+n*6+3 Цвет n (детали в атрибуте 21).
i{n} Изображение {n} 30+n*6+4 Изображение n (детали в атрибуте 26).
s{n} Стиль {n} 30+n*6+5 Стиль n.

1.2 Элемент формы (FormEl)

Примитив, предназначенный для предоставления, в распоряжение пользователя, стандартных элементов формы. Общий перечень атрибутов зависит от типа элемента.

Table. List of additional properties/attributes of the primitive "Element of the form (FormEl)"

Identifier Name Number Value
elType Element type 20 Type of the element, from which depends the list of additional attributes:
  • Line edit (0)
  • Text edit (1)
  • Check Box (2)
  • Button (3)
  • Combo box (4)
  • List (5)
  • Tree (8)
  • Table (9)
  • Slider (6)
  • Scroll bar (7)
Line edit:
value Value 21 Contents of the line.
view View 22 View of the editing line:
  • Text (0)
  • Combo Box (1)
  • Integer (2)
  • Real (3)
  • Time (4)
  • Date (5)
  • Date and Time (6)
  • Password (7)
cfg Configuration 23 Configuration of the line. Format of the value of the field for different views of the lines:
Text — configuration of the formatted input at the template with the parameters (supported only by Qt in UI.Vision):
A — ASCII alphabetic character required, [A-Za-z].
a — ASCII alphabetic character permitted but not required.
N — ASCII alphanumeric character required, [A-Za-z0-9].
n — ASCII alphanumeric character permitted but not required.
X — Any character required.
x — Any character permitted but not required.
9 — ASCII digit required, [0-9].
0 — ASCII digit permitted but not required.
D — ASCII digit required, [1-9].
d — ASCII digit permitted but not required.
# — ASCII digit or plus/minus sign permitted but not required.
H — Hexadecimal character required, [A-Fa-f0-9].
h — Hexadecimal character permitted but not required.
B — Binary character required, [0-1].
b — Binary character permitted but not required.
> — All following alphabetic characters are uppercased.
< — All following alphabetic characters are lowercased.
! — Switch off case conversion.
\\ — Use to shield the special characters listed above to use them as separators.
Combobox — list of values the editable combobox by lines.
Integer — integer value in the form: "{Min}:{Max}:{ChangeStep}:{Prefix}:{Suffix}".
Real — real value in the form: "{Min}:{Max}:{ChangeStep}:{Prefix}:{Suffix}:{SignsAfterDot}".
Time, Date, Date and time — to form the date following the template with the parameters:
d — number of the day (1-31);
dd — number of the day (01-31);
ddd — acronym of the day ("Mon" ... "Sun");
dddd — full name of the day ("Monday" ... "Sunday");
M — number of the month (1-12);
MM — number of the month (01-12);
MMM — acronym of the month ("Jan" ... "Dec");
MMMM — full name of the month ("January" ... "December");
yy — last two digits of the year;
yyyy — full year;
h — hour (0-23);
hh — hour (00-23);
m — minutes (0-59);
mm — minutes (00-59);
s — seconds (0-59);
ss — seconds (00-59);
AP,ap — to display AM/PM or am/pm.
confirm Confirm 24 Enable the confirming mode.
font Font 25 Font name in the 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.
Text edit:
value Value 21 Content of the editor.
wordWrap Word wrap 22 Automatically wrap text by words.
confirm Confirm 24 Enable the confirming mode.
font Font 25 Font name in the form "{family} {size} {bold} {italic} {underline} {strike}" (details above).
Check box:
name Name 26 Name/label of the checkbox.
value Value 21 Value of the checkbox.
font Font 25 Font name in the form "{family} {size} {bold} {italic} {underline} {strike}" (details above).
Button:
name Name 26 Name-inscription on the button. Allowed symbols '\n' for multiple line names.
value Value 21 The value, different for modes:
  • "Standard" — repeating parameters of events on holding {delay}-{interval}, time in milliseconds;
  • "Checkable" — toggle value;
  • "Menu" — list of addresses of the menu elements like to /grp1/grp2/item1;
  • "Load" — description line {FilesTemplate}|{Header}|{FileByDefaultAndLoaded}|{FileMime} and loaded file content from next line. The files template like to "Images (*.png *.xpm *.jpg);;CSV-file (*.csv)".
  • "Save" — description line {FilesTemplate}|{Header}|{FileByDefault}|{FileMime} and saving file content from next line. The files template like to before one.
img Image 22 Image on the button. Image name in the view [{src}:]{name}, where:
  • "src" — source of the image:
    • file — directly from the local file by the path;
    • res — from the resources table of DB.
  • "name" — file path or identifier of the resource.

Examples:

  • "res:backLogo" — from the resources table of DB for the identifier "backLogo";
  • "backLogo" — like toe the previous;
  • "file:/var/tmp/backLogo.png" — from local file by the path "/var/tmp/backLogo.png".
color Color 23 Color of the button. Color name form "{color}[-{alpha}]", where:
  • "color" — standard color name or its numeric representation of three hexadecimal numbers of individual colors "#RRGGBB";
  • "alpha" — level of the alpha [0...255], where 0 — completely transparent.

Examples:

  • "red" — solid red color;
  • "#FF0000" — solid red color by the digital code;
  • "red-127" — half transparent red color.
colorText Color:text 27 Color of the text (details above).
mode Mode 24 Operation mode of the button:
  • "Standard" — normal button which allows repeating events on it hold, the parameters in "value";
  • "Checkable" — check button, values in "value";
  • "Menu" — opens menu on press, items list in "value";
  • "Load" — provides for loading of the user-space small files through the visual interface; on the mode the button press will open the selection file dialog for loading and the file content next saving to the attribute "value";
  • "Save" — provides for saving of the user-space small files through the visual interface; on the file content writing to the attribute "value" for user will: open the selecting/setting file dialog, save the attribute "value" content to the file, after the selecting, and set clean the attribute "value".
font Font 25 Font name in the form "{family} {size} {bold} {italic} {underline} {strike}" (details above).
List:
value Value 21 Current value of the list.
items Items 22 Entries of the list.
font Font 25 Font name in the form "{family} {size} {bold} {italic} {underline} {strike}" (details above).
mult Multiple selection 23 Allow for multiple entries selection of the list.
Combo box, Tree:
value Value 21 Current value of the list.
items Items 22 Entries of the list or hierarchical items list of the tree in path "/{DIR}/{DIR}/{ITEM}".
font Font 25 Font name in the form "{family} {size} {bold} {italic} {underline} {strike}" (details above).
Table:
set Setting value 23 Value of edition of a cell of the table which address in the event "ws_TableEdit_{colN}_{rowN}".
value Value 21 Address of the selected item. It changing follows by the event "ws_TableChangeSel". The address format depends from the table's selection mode:
  • "Cell" — cell address in the format "{row}:{col}".
  • "Row", "Column" — row-column number or cell content of the row-column key, which sets by the attribute "keyID".
items Elements 22

The table structure and content in the XML view: 

<tbl>
<h><s>{Header1}</s><s>{Header2}</s></h>
<r><s>{Row1Column1String}</s><i>{Row1Column1Integer}</i></r>
<r><b>{Row2Column1Logical}</b><r>{Row2Column2Real}</r></r>
</tbl>

The tags:

"tbl" — Table, the properties at all:
  • "sel" — selection mode of the table items: "row" — by rows, "col" — by columns, "cell" — by cells (by default);
  • "keyID" — row-column number of the key, for the selection value get;
  • "colsWdthFit" — fits the columns size, in the unfixed size, to fill the full width of the table;
  • "hHdrVis", "vHdrVis" — visibility of the headers, for horizontal and vertical;
  • "sortEn" — enables sorting directly by the columns.
"h" — Row of the headers. Possible attributes of the header cell tag for the column as a whole:
  • "width" — column width, in pixels or percents (10%);
  • "edit" — allowing to the cells of the row edition (0 or 1), by default — no (0);
  • "color" — column color as a whole in the color name or code;
  • "colorText" — color of the column text as a whole in the color name or code;
  • "font" — font of the column text in the typical OpenSCADA string;
  • "prec" — value precision of the real type cells in the column;
  • "sort" — sorting by the column [0 - Ascending-default; 1 - Descending];
  • "align" — alignment the column for: "left", "right" and "center".
"r" — Row of the values. Possible attributes of the row cell tag for the row as a whole:
  • "color" — row color as a whole in the color name or code;
  • "colorText" — color of the row text as a whole in the color name or code;
  • "font" — font of the cell text in the typical OpenSCADA string;
  • "prec" — value precision of the real type cells in the row.
"s", "t", "i", "r", "b" — cells of the data types "String", "Text", "Integer", "Real" and "Logical". Possible attributes:
  • "color" — cell color;
  • "colorText" — color of the cell text in the color name or code;
  • "font" — font of the cell text in the typical OpenSCADA string;
  • "prec" — value precision of the real type cell;
  • "img" — image of the cell in the form "[{src}:]{name}", the details above;
  • "edit" — allowing the cell edition (0 or 1), by default - no (0);
  • "align" — alignment the cell for: "left", "right" and "center".
font Font 25 Font name in the form "{family} {size} {bold} {italic} {underline} {strike}" (the details above).
Slider and Scroll Bar:
value Value 21 Slider position.
cfg Configuration 22 Configuration of the slider in the format: "{VertOrient}:{Min}:{Max}:{SinglStep}:{PageStep}".

Where:

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

1.3 Элемент текста (Text)

Данный примитив предназначен для вывода простого и HTML текста, используемого в роли меток и различных подписей. С целью создания декоративных оформлений, примитив поддерживает обвод текста рамкой.

Таблица. Набор дополнительных свойств/атрибутов примитива "Элемент текста (Text)"

Идентификатор Имя Номер Значение
backColor Фон: цвет 20

Фоновый цвет. Имя цвета в виде "{color}[-{alpha}]", где:

  • "color" — стандартное имя цвета или его числовое представление из трёх шестнадцатеричных чисел отдельных цветов "#RRGGBB";
  • "alpha" — уровень альфа-канала [0...255], где 0 — полностью прозрачный.

Примеры:

  • "red" — сплошной красный цвет;
  • "#FF0000" — сплошной красный цвет в цифровом коде;
  • "red-127" — полупрозрачный красный цвет.
backImg Фон: изображение 21

Фоновое изображение. Имя изображения в виде "[{src}:]{name}", где:

  • "src" — источник изображения:
    • file — прямо из локального файла по пути;
    • res — из таблицы ресурсов БД.
  • "name" — путь файла или идентификатор ресурса.

Примеры:

  • "res:backLogo" — из таблицы ресурсов БД для идентификатора "backLogo";
  • "backLogo" — как и предыдущий;
  • "file:/var/tmp/backLogo.png" — из локального файла по пути "/var/tmp/backLogo.png".
bordWidth Граница: ширина 22 Ширина бордюра.
bordColor Граница: цвет 23 Цвет бордюра (детальнее в атрибуте 20).
bordStyle Граница: стиль 24 Стиль бордюра: "Нет" (0), "Точечный" (1), "Пунктирный" (2), "Сплошной" (3), "Двойной" (4), "Канавка" (5), "Кромка" (6), "Вдавлен" (7), "Выступающий" (8).
font Шрифт 25

Имя шрифта в виде "{family} {size} {bold} {italic} {underline} {strike}", где:

  • "family" — семейство шрифта, для пробелов используйте символ '_', вроде: "Arial", "Courier", "Times_New_Roman";
  • "size" — размер шрифта в пикселях;
  • "bold" — усиление шрифта (0 или 1);
  • "italic" — наклонность шрифта (0 или 1);
  • "underline" — подчёркивание шрифта (0 или 1);
  • "strike" — перечёркивание шрифта (0 или 1).

Примеры:

  • "Arial 10 1 0 0 0" — Arial шрифт размером 10 пикселей и усиленный.
color Цвет 26 Цвет текста (детальнее в атрибуте 20).
orient Угол поворота 27 Ориентация текста, угол поворота.
wordWrap Перенос слов 28 Автоматический перенос текста по словам.
alignment Выравнивание 29 Выравнивание текста: "Вверху слева" (0), "Вверху справа" (1), "Вверху по центру" (2), "Вверху по ширине" (3), "Внизу слева" (4), "Внизу справа" (5), "Внизу по центру" (6), "Внизу по ширине" (7), "По центру слева" (8), "По центру справа" (9), "По середине" (10), "По центру по ширине" (11).
inHtml В HTML 31 Отображение и поддержка содержимого аргумента text в HTML.
text Текст 30 Значение текста. Используйте "%{x}" для помещения значения аргумента "x" (от 1).
numbArg Количество аргументов 40 Количество аргументов.
Атрибуты аргументов
arg{x}val Аргумент {x}: значение 50+10*x Значение аргумента x.
arg{x}tp Аргумент {x}: тип 50+10*x+1 Тип аргумента x: "Целый" (0), "Вещественный" (1), "Строка" (2).
arg{x}cfg Аргумент {x}: конфигурация 50+10*x+2

Конфигурация аргумента x:

  • "Строка": {len} — ширина строки;
  • "Вещественный": {wdth};{form};{prec} — ширина, форма ('g', 'e', 'f') и точность значения;
  • "Целый": {len} — ширина значения.

1.4 Элемент отображения медиа-материалов (Media)

Данный примитив предназначен для проигрывания различных медиа-материалов, начиная от простых изображений и заканчивая полноценными аудио и видео потоками.

Table. List of additional properties/attributes of the primitive "Element of visualization of media-materials (Media)"

Identifier Name Number Value
backColor Background: color 20 Background color. Color name in the view "{color}[-{alpha}]", where:
  • "color" — standard color name or its numeric representation of three hexadecimal numbers of individual colors "#RRGGBB";
  • "alpha" — level of the alpha [0...255], where 0 — completely transparent.

Examples:

  • "red" — solid red color;
  • "#FF0000" — solid red color by the digital code;
  • "red-127" — half transparent red color.
backImg Background: image 21 Background image. The image name in the view "[{src}:]{name}", where:
  • "src" — source of the image:
    • file — directly from the local file by the path;
    • res — from the resources table of DB.
  • "name" — file path or identifier of the resource.

Examples:

  • "res:backLogo" — from the resources table of DB for the identifier "backLogo";
  • "backLogo" — like toe the previous;
  • "file:/var/tmp/backLogo.png" — from local file by the path "/var/tmp/backLogo.png".
bordWidth Border: width 22 Border width.
bordColor Border: color 23 Border color (details in attribute 20).
bordStyle Border: style 24 Border style: "None", "Dotted", "Dashed", "Solid", "Double", "Groove", "Ridge", "Inset", "Outset".
src Source 25

Name of the Media source in the view "[{src}:]{name}", where:

  • "src" — source:
    • file — directly from the local file, visualizer and engine, by the path;
    • res — from the resources table of DB;
    • data — directly data in the form "data:{mime}\n{base64}";
    • stream — stream URL for playback video and audio.
  • "name" — file path or identifier of the resource.

Examples:

  • "res:workMedia" — from the resources table of DB for the identifier "workMedia";
  • "workMedia" — like to previous;
  • "file:/var/tmp/workMedia.mng" — from the local file by the path "/var/tmp/workMedia.mng";
  • "stream:http://localhost.localhost:5050" — playback for video and audio stream from the URL.
type Type 27

Media type:

  • "Image" — raster or vector (can not support) image, like to: PNG, JPEG, GIF, SVG;
  • "Animation" — simple animation image, like to: GIF, MNG;
  • "Video" — full video or stream, like to: OGM, AVI, MKV, MPG, MP4;
  • "Audio" — just audio or stream, like to: OGG, MP3, WAV.
areas Map areas 28 Number of the active areas.
Attributes of the image (Image)
fit Fit to the widget size 26 Sign of coordination the contents with the widget size.
keepAspect Keep aspect ratio at fitting 35 Sign of keeping image aspect ratio at fitting to whole size of the widget.
Attributes of the animation-video (Animation)
fit Fit to the widget size 26 Sign of coordination the contents with the widget size.
speed Play speed 29 Speed of playback, as a percentage from the original speed. If the value is less or even than 1%, the playback stops.
Attributes of the full video (Full video)
play Play 29 Video/audio — "Play".
roll Roll play 30 Roll play on the finish.
pause Pause 31 Playing pause.
size Size 32 Total video size, in milliseconds.
seek Seek 33 Seek video playing, in milliseconds.
volume Volume 34 Sound volume [0...100].
Active areas
area{x}shp Area {x}: shape 40+3*x Type of the area x: "Rect", "Poly", "Circle".
area{x}coord Area {x}: coordinates 40+3*x+1 Coordinates of the area x, are separated by commas: "x1,y1,x2,y2,xN,yN".
area{x}title Area {x}: title 40+3*x+2 Title of the area x.

1.5 Элемент построения диаграмм (Diagram)

Данный примитив предназначен для построения различных диаграмм во времени, включая графики-тренды отображения текущего процесса и архивных данных. Реализованы следующие типы диаграмм:

  • "График-тренд" — строит график значений параметра во времени.
  • "Спектр" — строит частотный спектр из значений параметров. Окно данных частотного спектра формируется исходя из размера виджета по горизонтали, в пикселях, и доступных данных параметров, наложенных на сетку горизонтального размера. В связи с этим, минимальная выделяемая частота определяется значением атрибута "tSize" — "1/tSize", а максимальная, половинной шириной графика в пикселях умноженной на минимальную частоту "width/(2*tSize)".
  • "XY" — строит двумерный график значений параметров, парами на график, где чётные по оси Y (0,2,4...) и нечётные по оси X (1,3,5...). Указанный временной диапазон данных используется в получении значений параметров оси X и Y, с последующим изображением.

Для всех типов диаграмм возможно указание, в качестве источника данных:

  • параметра подсистемы "Сбор Данных";
  • архива значений;
  • прямого блока данных пользователя.

Поддерживается режим слеживания за текущими значениями и значениями с архива, а также, возможно построение графиков параметров, не имеющих архива значений, путём накопления текущих значений в буфере диаграммы и только на момент активного отображения этой диаграммы.

Процесс доступа к архивным данным оптимизирован путём ведения промежуточного буфера отображения, а также, упаковки трафика данных при запросе, путем приведения данных к качеству достаточного для отображения.

Таблица. Набор дополнительных свойств/атрибутов примитива "Элемент построения диаграмм (Diagram)"

Идентификатор Имя Номер Значение
backColor Фон: цвет 20

Фоновый цвет. Имя цвета в виде "{color}[-{alpha}]", где:

  • "color" — стандартное имя цвета или его числовое представление из трёх шестнадцатеричных чисел отдельных цветов "#RRGGBB";
  • "alpha" — уровень альфа-канала [0...255], где 0 — полностью прозрачный.

Примеры:

  • "red" — сплошной красный цвет;
  • "#FF0000" — сплошной красный цвет в цифровом коде;
  • "red-127" — полупрозрачный красный цвет.
backImg Фон: изображение 21

Фоновое изображение. Имя изображения в виде "[{src}:]{name}", где:

  • "src" — источник изображения:
    • file — прямо из локального файла по пути;
    • res — из таблицы ресурсов БД.
  • "name" — путь файла или идентификатор ресурса.

Примеры:

  • "res:backLogo" — из таблицы ресурсов БД для идентификатора "backLogo";
  • "backLogo" — как и предыдущий;
  • "file:/var/tmp/backLogo.png" — из локального файла по пути "/var/tmp/backLogo.png".
bordWidth Граница: ширина 22 Ширина бордюра.
bordColor Граница: цвет 23 Цвет бордюра (детальнее в атрибуте 20).
bordStyle Граница: стиль 24 Стиль бордюра: "Нет", "Точечный", "Пунктирный", "Сплошной", "Двойной", "Канавка", "Кромка", "Вдавлен", "Выступающий".
trcPer Период слежения, секунд 25 Режим и периодичность слежения.
type Тип 26 Тип диаграммы: "График", "Спектр", "XY".
Атрибуты, общие для всех типов
tSek Время: секунды 27 Текущее время, секунд.
tUSek Время: микросекунды 28 Текущее время, микросекунды.
tSize Размер, секунды 29 Размер данных, секунды.
curSek Курсор: секунды 30 Положение курсора, секунды.
curUSek Курсор: микросекунды 31 Положение курсора, микросекунды.
curColor Курсор: цвет 32 Цвет курсора.
sclColor Шкала: цвет 33 Цвет шкалы-решетки (детальнее в атрибуте 20).
sclHor Шкала: горизонтальная 34 Режим горизонтальной шкалы-решетки: "Не рисовать", "Решетка", "Маркеры", "Решетка и маркеры", "Решетка (лог)", "Маркеры (лог)", "Решетка и маркеры (лог)".
sclHorScl Шкала: гориз. масштаб (%) 44 Горизонтальный масштаб графика в процентах, исключительно для типа "XY".
sclHorSclOff Шкала: смещ. гориз. масштаба (%) 45 Смещение горизонтального маштаба в процентах, исключительно для типа "XY".
sclVer Шкала: вертикальная 35 Режим вертикальной шкалы-решетки: "Не рисовать", "Решетка", "Маркеры", "Решетка и маркеры", "Решетка (лог)", "Маркеры (лог)", "Решетка и маркеры (лог)".
sclVerScl Шкала: верт. масштаб (%) 40 Вертикальный масштаб графика в процентах.
sclVerSclOff Шкала: смещ. верт. масштаба (%) 41 Смещение вертикального масштаба в процентах.
sclMarkColor Шкала: Маркеры: цвет 36 Цвет маркеров шкалы-решетки (детальнее в атрибуте 20).
sclMarkFont Шкала: Маркеры: шрифт 37

Шрифт маркеров шкалы-решетки. Имя шрифта в виде "{family} {size} {bold} {italic} {underline} {strike}", где:

  • "family" — семейство шрифта, для пробелов используйте символ '_', вроде: "Arial", "Courier", "Times_New_Roman";
  • "size" — размер шрифта в пикселях;
  • "bold" — усиление шрифта (0 или 1);
  • "italic" — наклонность шрифта (0 или 1);
  • "underline" — подчёркивание шрифта (0 или 1);
  • "strike" — перечёркивание шрифта (0 или 1).

Примеры:

  • "Arial 10 1 0 0 0" — Arial шрифт размером 10 пикселей и усиленный.
valArch Архиватор значений 38 Архиватор значений в виде "{МодульАрхивов}.{IdАрхиватора}".
valsForPix Значений на пиксель 42 Количество значений на пиксель. Увеличить для расширения точности экспорта на больших интервалах времени.
parNum Количество параметров 39 Количество параметров, отображаемых на одном тренде.
Атрибуты типа: "График"
sclHorPer Шкала: размер гор. решетки, секунды 43 Фиксированный период решётки горизонтальной шкалы — отключает автоматическое вычисление периода решётки. Активируется если количество периодов на общий размер более двух и размер одного периода не менее 15 пикселей.
Индивидуальные атрибуты параметров
prm{X}addr Параметр {X}: адрес 50+10*{X}

Полный адрес к атрибуту параметра X DAQ или архиву.
Поддерживается прямая установка данных по префиксу:

  • "data:{XMLNodeData}" — изображение из прямо установленных данных;
  • "line:{значение}" — изображение горизонтальной линии по значению, не имеет смысла для типа "XY".

Пример:

  • "/DAQ/System/AutoDA/MemInfo/use" — адрес к атрибуту "use" параметра "MemInfo" объекта контроллера "AutoDA" DAQ модуля "System";
  • "/Archive/va_CPULoad_load" — адрес к архиву "CPULoad_load";
  • "data:<d s="1" aprox="1" tm="1369465209" tm_grnd="1369465200" per="1">
0 3.14
1 3.141
5 3.1415</d>" — 10 секунд данных с периодом 1 секунда от "25.05.2013 10:00:00"; возможно "tm" и "tm_grnd" не указывать, в результате чего будут подставлены значения диапазона диаграммы, также, установкой атрибута "s", можно указать на время в секундах; "aprox" — аппроксимировать переход от одной точки к другой вместо подстановки предыдущего значения во все точки периодичности от упаковки;
  • "line:3.14159265" — горизонтальная линия по значению "3.14159265".
prm{X}bordL Параметр {X}: граница отображ.: нижняя 50+10*{X}+1 Нижняя граница значений параметра X.
prm{X}bordU Параметр {X}: граница отображ.: верхняя 50+10*{X}+2 Верхняя граница значений параметра X.
prm{X}color Параметр {X}: цвет 50+10*{X}+3 Цвет отображения графика параметра X (детальнее в атрибуте 20).
prm{X}width Параметр {X}: ширина 50+10*{X}+6 Ширина линии графика параметра X, в пикселях.
prm{X}scl Параметр {X}: шкала 50+10*{X}+5 Режим отдельной вертикальной шкалы параметра X: "Глобально", "Маркеры", "Решетка и маркеры", "Маркеры (лог)", "Решетка и маркеры (лог)".
prm{X}val Параметр {X}: значение 50+10*{X}+4 Значение параметра X под курсором, или на текущее время, для типа "XY".
prm{X}prop Параметр {X}: свойства 50+10*{X}+7 Свойства реального архива в виде "{BegArh}:{EndArh}:{DataPeriod}", где "BegArh", "EndArh", "DataPeriod" — начало, конец и период данных архива, в секундах, в вещественном представлении, вплоть до микросекунд (1e-6).

1.6 Элемент построения протоколов на основе архивов сообщений (Protocol)

Данный примитив предназначен для визуализации данных архива сообщений путём формирования протоколов с различными способами визуализации, начиная от статического сканирующего просмотра и заканчивая динамическим слеживанием.

Таблица. Набор дополнительных свойств/атрибутов примитива "Элемент построения протоколов на основе архивов сообщений (Protocol)"

Идентификатор Имя Номер Значение
backColor Фон: цвет 20

Фоновый цвет. Имя цвета в виде "{color}[-{alpha}]", где:

  • "color" — стандартное имя цвета или его числовое представление из трёх шестнадцатеричных чисел отдельных цветов "#RRGGBB";
  • "alpha" — уровень альфа-канала [0...255], где 0 — полностью прозрачный.

Примеры:

  • "red" — сплошной красный цвет;
  • "#FF0000" — сплошной красный цвет в цифровом коде;
  • "red-127" — полупрозрачный красный цвет.
backImg Фон: изображение 21

Фоновое изображение. Имя изображения в виде "[{src}:]{name}", где:

  • "src" — источник изображения:
    • file — прямо из локального файла по пути;
    • res — из таблицы ресурсов БД.
  • "name" — путь файла или идентификатор ресурса.

Примеры:

  • "res:backLogo" — из таблицы ресурсов БД для идентификатора "backLogo";
  • "backLogo" — как и предыдущий;
  • "file:/var/tmp/backLogo.png" — из локального файла по пути "/var/tmp/backLogo.png".
font Шрифт 22

Имя шрифта в виде "{family} {size} {bold} {italic} {underline} {strike}", где:

  • "family" — семейство шрифта, для пробелов используйте символ '_', вроде: "Arial", "Courier", "Times_New_Roman";
  • "size" — размер шрифта в пикселях;
  • "bold" — усиление шрифта (0 или 1);
  • "italic" — наклонность шрифта (0 или 1);
  • "underline" — подчёркивание шрифта (0 или 1);
  • "strike" — перечёркивание шрифта (0 или 1).

Примеры:

  • "Arial 10 1 0 0 0" — Arial шрифт размером 10 пикселей и усиленный.
headVis Заголовок видим 23 Видимость заголовка таблицы.
time Время, секунды 24 Текущее время, секунды.
tSize Размер, секунды 25 Размер запроса данных, секунды. Установить значение в '0' для получения всех нарушений, для "lev" < 0.
trcPer Период слежения, секунды 26 Режим и периодичность слежения.
arch Архиватор 27 Архиватор сообщений в виде "{МодульАрхивов}.{IdАрхиватора}".
tmpl Шаблон 28

Шаблон категории или регулярное выражение "/{re}/". Для шаблона зарезервированы символы:

  • '*' — множество любых, группа символов;
  • '?' — любой, один символ;
  • '\\' — используйте для экранирования специальных символов.
lev Уровень 29 Уровень сообщений. Установите значение < 0 для получения текущих нарушений.
viewOrd Порядок отображения 30 Порядок отображения: "По времени", "По уровню", "По категории", "По сообщению", "По времени (обратно)", "По уровню (обратно)", "По категории (обратно)", "По сообщению (обратно)".
col Показать колонки 31

Список видимых и порядок колонок, разделённый символом ';'. Предусматриваются колонки:

  • "pos" — номер строки;
  • "tm" — дата и время сообщения;
  • "utm" — микросекундная часть времени сообщения;
  • "lev" — уровень сообщения;
  • "cat" — категория сообщения;
  • "mess" — текст сообщения.
itProp Свойства элемента 32 Количество свойств элемента.
Индивидуальные атрибуты свойств элемента
it{X}lev Элемент {X}: уровень 40+5*{X} Критерий: уровень элемента X более или равно указанному.
it{X}tmpl Элемент {X}: шаблон 40+5*{X}+1 Критерий: шаблон категории элемента X (детальнее в атрибуте 28).
it{X}fnt Элемент {X}: шрифт 40+5*{X}+2 Шрифт элемента X (детальнее в атрибуте 22).
it{X}сolor Элемент {X}: цвет 40+5*{X}+3 Цвет элемента X (детальнее в атрибуте 20).

1.7 Элемент формирования отчётной документации (Document)

Примитив предназначен для формирования отчётной, оперативной и иной документации на основе шаблонов документов.

Таблица. Набор дополнительных свойств/атрибутов примитиве "Элемент формирования отчётной документации (Document)"

Идентификатор Имя Номер Значение
style CSS 20 Правила CSS в строках, вида "body { background-color:#818181; }".
tmpl Шаблон 21

Шаблон документа в XHTML, начиная с тега "body" и включая процедурные вставки: 

<body docProcLang="JavaLikeCalc.JavaScript">
  <h1>Значение<?dp return wCod+1.314;?></h1>
</body>
doc Документ 22 Финальный документ в XHTML, начинается с тега "body".
font Шрифт 26

Базовый шрифт текста документа. Имя шрифта в виде "{family} {size} {bold} {italic} {underline} {strike}", где:

  • "family" — семейство шрифта, для пробелов используйте символ '_', вроде: "Arial", "Courier", "Times_New_Roman";
  • "size" — размер шрифта в пикселях;
  • "bold" — усиление шрифта (0 или 1);
  • "italic" — наклонность шрифта (0 или 1);
  • "underline" — подчёркивание шрифта (0 или 1);
  • "strike" — перечёркивание шрифта (0 или 1).

Примеры:

  • "Arial 10 1 0 0 0" — Arial шрифт размером 10 пикселей и усиленный.
bTime Время: начало 24 Время начала документа, секунды.
time Время: текущее 23 Время генерации документа, секунды. Записать время для генерации документа от этой точки или нуль для перегенерации.
process В процессе 27 Признак процесса формирования документа отдельным потоком.
n Размер архива 25 Количество документов или глубина архива.
Атрибуты включеного режима архивирования
aCur Архив: курсор: текущий - Позиция текущего документа в архиве. Запись значения <0 производит архивацию текущего документа.
vCur Архив: курсор: вид -

Текущий визуализируемый документ архива. Запись значения:

  • -1 — выбор следующего документа;
  • -2 — выбор предыдущего документа.
aDoc Архив: текущий документ - Текущий документ архива в XHTML, начинается с тега "body".
aSize Архив: размер - Реальный размер архива документа.

Возможности примитива "Документ":

  • Гибкое формирование структуры документа на основе языка гипертекстовой разметки, что предоставляет поддержку широких возможностей форматирования документов.
  • Формирование документов по команде или расписанию, что необходимо для формирования отчётной документации в архив, с последующим просмотром архива.
  • Формирование документов в режиме реального времени, для предоставления их полностью динамически и на основе архивов за указанное время.
  • Использование атрибутов виджета для передачи в документ значений и адресов на архивы, что позволяет использовать виджет документа как шаблон, при формировании отчётов с другими входными данными.

В основе любого документа лежит XHTML-шаблон. XHTML-шаблон это тег "body" WEB-страницы, содержащий статику документа в стандарте XHTML 1.0 и элементы исполняемых инструкций на языке пользовательского программирования OpenSCADA, в виде <?dp {procedure} ?>. Результирующий документ формируется путём исполнения процедур и вставки их результата в документ.

Источником значений исполняемых инструкций являются атрибуты виджета этого примитива, а также все механизмы языка пользовательского программирования OpenSCADA. Атрибуты могут добавляться пользователем и линковаться на реальные атрибуты параметров или-же являться автономными, значения которых будут формироваться в процедуре виджета. В случае со слинкованными атрибутами, значения могут извлекаться из архива-истории.

На рисунке изображена структурная схема виджета примитива "Документ". Согласно этой структуре, "Документ" содержит: XHTML-шаблон, результирующие документы и процедуру обработки данных. Источником данных процедуры и результирующих документов являются атрибуты виджета.

Рисунок. Структурная схема примитива "Документ".

Предусматривается работа виджета в двух режимах: "Динамический" и "Архивный". Отличием архивного режима является наличие архива указанной глубины и атрибутов, позволяющих управлять процессом архивирования и просмотра указанного документа в архиве.

Генерация документа всегда производится в момент установки атрибута времени time относительно установленного ранее начального времени документа в атрибуте bTime. При выключенном архиве, результирующий документ помещается непосредственно в атрибут doc. При включенном архиве, результирующий документ помещается в ячейку под курсором, атрибут aCur, а так-же в doc, если значение курсора архива aCur и курсора визуализируемого документа vCur совпадают. Атрибуты архивных курсоров предусматривают несколько командных значений:

  • "aCur < 0" — перемещает курсор архиватора на следующую позицию, тем самым оставляя предыдущий документ в архиве и очищая документ под курсором, если кольцевой архив замкнулся.
  • "vCur == -1" — выбор следующего документа для отображения, выбранный документ копируется в атрибут doc.
  • "vCur == -2" — выбор предыдущего документа для отображений, выбранный документ копируется в атрибут doc.

Как было указано выше, динамика шаблона документа определяется вставками исполняемых инструкций вида "<?dp {procedure} ?>". В процедурах могут использоваться одноимённые атрибуты виджета и функции пользовательского интерфейса программирования OpenSCADA. Кроме атрибутов виджета, зарезервированы специальные атрибуты, смотри таблицу.

Таблица. Специальные и зарезервированные элементы шаблона.

Имя Назначение
Атрибуты
rez Атрибут результата исполнения процедуры, содержимое которого помещается в дерево документа.
lTime Время последнего формирования. Если документ формируется впервые то lTime равен bTime.
rTime Содержит время перебираемых значений, секунды, определяется внутри тегов с атрибутом "docRept".
rTimeU Содержит время перебираемых значений, микросекунды, определяется внутри тегов с атрибутом "docRept".
rPer Содержит период перебора значений, атрибут "docRept".
mTime, mTimeU, mLev, mCat, mVal

Определяются внутри тегов с атрибутом "docAMess" при разборе сообщений архива сообщений:

mTime — время сообщения, секунды;
mTimeU — время сообщения, микросекунды;
mLev — уровень сообщения;
mCat — категория сообщения;
mVal — значение сообщения.
Специальные теги
Специальные атрибуты стандартных тегов
body.docProcLang Язык исполняемых процедур документа, по умолчанию это "JavaLikeCalc.JavaScript".
*.docRept="1s" Тег с указанным атрибутом размножается, при формировании, путём смещения времени в атрибуте "rTime" на значение, указанное в данном атрибуте.
*.docAMess="1:PLC*" Указывает на необходимость размножения тега с атрибутом, сообщениями из архива сообщений за указанный интервал времени, согласно уровня "1" и шаблона запроса "PLC*", по категории сообщения. В шаблоне запроса могут указываться регулярные выражения в виде "/{re}/". Для данного тега, в процессе размножения, определяются атрибуты: "mTime", "mTimeU", "mLev", "mCat" и "mVal".
*.docAMessArchs="ArchMod0.Archivator0[;ArchModN.ArchivatorN]" Дополняет атрибут "*.docAMess" перечнем архиваторов для чтения сообщений.
*.docRevers="1" Указывает на инвертирование порядка размножения — последний сверху.
*.docAppend="1" Признак необходимости добавления результата выполнения процедуры в тег процедуры. Иначе результат исполнения заменяет содержимое тега.
body.docTime Время формирования документа, используется для установки атрибута lTime при следующем формировании документа. Не устанавливается пользователем!
table.export="1" Включение возможности экспорта содержимого указанной таблицы в CSV-файл и другие табличные форматы.

1.8 Контейнер (Box)

Примитив контейнера, используется для формирования составных виджетов и/или страниц пользовательского интерфейса.

Таблица. Набор дополнительных свойств/атрибутов примитива "Контейнер (Box)"

Идентификатор Имя Номер Значение
pgOpenSrc Страница: источник открытия 3 Полный адрес страницы, которая включена внутрь данного контейнера.
pgGrp Страница: группа 4 Группа контейнера включаемых страниц. Только страницы в такой группе будут включаться в этот бокс как контейнер.
backColor Фон: цвет 20

Фоновый цвет. Имя цвета в виде "{color}[-{alpha}]", где:

  • "color" — стандартное имя цвета или его числовое представление из трёх шестнадцатеричных чисел отдельных цветов "#RRGGBB";
  • "alpha" — уровень альфа-канала [0...255], где 0 — полностью прозрачный.

Примеры:

  • "red" — сплошной красный цвет;
  • "#FF0000" — сплошной красный цвет в цифровом коде;
  • "red-127" — полупрозрачный красный цвет.
backImg Фон: изображение 21

Фоновое изображение. Имя изображения в виде "[{src}:]{name}", где:

  • "src" — источник изображения:
    • file — прямо из локального файла по пути;
    • res — из таблицы ресурсов БД.
  • "name" — путь файла или идентификатор ресурса.

Примеры:

  • "res:backLogo" — из таблицы ресурсов БД для идентификатора "backLogo";
  • "backLogo" — как и предыдущий;
  • "file:/var/tmp/backLogo.png" — из локального файла по пути "/var/tmp/backLogo.png".
bordWidth Граница: ширина 22 Ширина бордюра.
bordColor Граница: цвет 23 Цвет бордюра (детальнее в атрибуте 20).
bordStyle Граница: стиль 24 Стиль бордюра: "Нет", "Точечный", "Пунктирный", "Сплошной", "Двойной", "Канавка", "Кромка", "Вдавлен", "Выступающий".
Retrieved from "http://oscada.org/wiki/index.php?title=Translations:Modules/VCAEngine/19/ru&oldid=42657"