(Created page with "=== Примитивы виджетов === {{#lst:Sub-projects/VCA/ru|Primitives}}") |
|||
Line 1: | Line 1: | ||
− | === Примитивы виджетов === | + | === {{Anch|WidgetPrimitives|Примитивы виджетов}} === |
{{#lst:Sub-projects/VCA/ru|Primitives}} | {{#lst:Sub-projects/VCA/ru|Primitives}} |
Latest revision as of 16:59, 7 June 2019
Contents
[hide]- 1 Примитивы виджетов
- 1.1 Элементарная графическая фигура (ElFigure)
- 1.2 Элемент формы (FormEl)
- 1.3 Элемент текста (Text)
- 1.4 Элемент отображения медиа-материалов (Media)
- 1.5 Элемент построения диаграмм (Diagram)
- 1.6 Элемент построения протоколов на основе архивов сообщений (Protocol)
- 1.7 Элемент формирования отчётной документации (Document)
- 1.8 Контейнер (Box)
1 Примитивы виджетов
Любой вновь создаваемый виджет основывается на одном из нескольких примитивов — конечном элементе визуализации, путём установки родственной связи как прямо на примитив, так и посредством нескольких промежуточных пользовательских виджетов. Каждый из примитивов содержит механизм модели данных. Экземпляр виджета хранит значения свойств собственной конфигурации примитива.
В задачи интерфейса визуализации входит поддержка и работа с моделью данных примитивов виджетов. Примитивы виджетов должны быть тщательно проработаны и унифицированы, с целью охватить как можно больше возможностей в как можно меньшем количестве слабо связанных друг с другом, по назначению, примитивов.
Таблица. Библиотека примитивов виджетов — базовые элементы отображения
Идентификатор | Наименование | Функция |
---|---|---|
ElFigure | Элементарная графическая фигура |
Примитив является основой отрисовки элементарных графических фигур со всевозможной комбинацией их в одном объекте. Предусматривается поддержка следующих элементарных фигур:
Для всех фигур, содержащихся в виджете, устанавливаются единые свойства толщины, цвета и т.д., также, предусматривается возможность указания вышеперечисленных атрибутов для каждой фигуры отдельно и их динамизация. |
FormEl | Элемент формы |
Включает поддержку стандартных компонентов формы:
|
Text | Текст | Элемент текста-метка. Характеризуется типом шрифта, цветом, ориентацией и выравниванием. Предусматривается поддержка аргументов. |
Media | Медиа | Элемент отображения растровых и векторных изображений различных форматов, проигрывания анимированных изображений, проигрывание аудио-фрагментов и просмотр видео-фрагментов. |
Diagram | Диаграмма | Элемент диаграммы с поддержкой возможности отображения нескольких потоков в реальном времени для: трендов (временных графиков), частотного спектра, XY диаграмм. |
Protocol | Протокол | Элемент протокола — визуализатор сообщений программы, с поддержкой нескольких режимов работы. |
Document | Документ | Элемент формирования отчётов, журналов и другой документации на основе доступных данных. |
Box | Контейнер | Содержит механизм размещения-включения других виджетов для формирования новых, более сложных, виджетов и страниц конечной визуализации. |
Function, в планах | Функция API объектной модели OpenSCADA | Невизуальный виджет, на стороне исполнения, позволяющий включать вычислительные функции объектной модели OpenSCADA в СВУ. |
Table. The common set of properties/attributes in the widget
Identifier | Name | Number | Value |
---|---|---|---|
id | Identifier | - | Identifier of the element. The attribute is read-only, designed to provide information on the ID of the element. |
path | Path | - | Path to the widget. The attribute is read-only and designed to provide full information about the element location. |
parent | Parent | - | Path to the parent widget. The attribute is read-only and designed to provide information about the ancestor location which the widget is inherited from. |
owner | Owner | - | The widget owner and group in the view "{owner}:{group[,group1,groupN]}", by default the "root:UI". |
perm | Permission | - |
Permission to the widget in the view "{user}{group}{other}" of octal number like to "0664-RWRWR_", plus the inheritance flag enables the inheritance for owner and its permissions from the upper widget.
By default that is in 01000 — inheritance. |
root | Root | 1 | Identifier of the widget-primitive (basic element) which underlies the widget visualization shape. |
name | Name | - | Name of the element. Accessible to modification the element name. |
dscr | Description | - | Description of the element. Text field of the brief description. |
en | Enabled | 5 | The state "Enabled" of the element. Disabled element is not shown in the execution mode. |
active | Active | 6 | The state "Active" of the element. Active element may receive focus in the execution mode, and thus receive keyboard and other events with their subsequent processing. |
geomX | Geometry: x | 7 | Geometry, coordinate 'x' of the element position. |
geomY | Geometry: y | 8 | Geometry, coordinate 'y' of the element position. |
geomW | Geometry: width | 9 | Geometry, the width of the element. |
geomH | Geometry: height | 10 | Geometry, the height of the element. |
geomXsc | Geometry: x scale | 13 | Horizontally scale of the element. |
geomYsc | Geometry: y scale | 14 | Vertical scale of the element. |
geomZ | Geometry: z | 11 | Geometry, coordinate 'z' (level) of the element on the frame. Defines also the order to transfer the focus through active elements. |
geomMargin | Geometry: margin | 12 | Geometry, the margins of the element. |
tipTool | Tip: tool | 15 | Text of a brief help or tip on this element. Realized usually as a tool tip, while keeping your mouse cursor over the element. |
tipStatus | Tip: status | 16 |
Text information on the status of the element or the guide to action over the element. Implemented usually in the form of a message in the status bar while keeping your mouse cursor over the element.
|
contextMenu | Context menu | 17 |
Context menu in the strings list view: "{ItName}:{Signal}".
|
evProc | Events processing | - |
Attribute for storing of the script of the events processing for direct control of the user interface. Script is a list of commands to the visualization interface, generated at the event receipt (attribute event). Direct events processing to manage pages, in the view: "{event}:{evSrc}:{com}:{prm}". Where:
Examples:
|
Additional attributes for items, placed into the project in the role of a page. | |||
pgOpen | Page: opened | - |
Sign "The page is opened".
|
pgNoOpenProc | Page: process not opened | - | Sign "Execute the page, even if it is closed". |
pgOpenSrc | Page: source of the opening | 3 |
Full address of the page which has opened this one.
|
pgGrp | Page: group | 4 | Group of the pages. EMPTY and the "main" group is meant of using this page as the Root-main page, so such ones will replace other Root-main pages; the "fl" group is meant of using in the "fly" windows which are suitable for multiple open and must not be traced for doubles; all other are meant for including to the containers-boxes or single opening, so they forced in checking for doubles when the last one will be opened and the previous ones be closed. |
Additional attributes of the execution mode — by the session. (Virtual attributes are not available in the widget procedure) | |||
event | Events | - | Special attribute of the collection of events of the widget in the list, which is divided by the new line. Access to the attribute is protected by a critical section in order to avoid loss of the events. The attribute is always available in the widget procedure. |
load | Load | -1 | Virtual command of the group data download. |
focus | Focus | -2 | Special attribute of the indicating the fact of receiving the focus by an active widget. Attribute of the widget and of the included widgets is available in the widgets procedures. |
perm | Permission | -3 | Virtual attribute of the rights of the active user to view and control the widget. |
- * — Специальная функция атрибута виджета, выполняемая в сеансе проекта при пользовательской модификации.
Движок среды визуализации предусматривает активацию атрибутов, специфичных для визуализатора. Процесс активации осуществляется при открытии сеанса визуализации проекта и предусматривает, в этом проекте: создание специфичного атрибута с указанными свойствами, если он отсутствует, и активацию отслеживания его модификации движком среды визуализации, как для атрибутов формирования образов примитивов. Для непосредственного определения такого атрибута можно также использовать префикс идентификатора атрибута "vs_", что быстрее и исключает стадию активации. С перечнем специфичных для визуализатора атрибутов можно ознакомиться в документации соответствующего визуализатора.
1.1 Элементарная графическая фигура (ElFigure)
Примитив является основой в отрисовке элементарных графических фигур со всевозможной их комбинацией в одном объекте. Учитывая широкий спектр всевозможных фигур, которые должен поддерживать примитив, и, в тоже время, являться достаточно простым в использовании и, по возможности, в реализации, было решено ограничить перечень базовых фигур, используемых для построения результирующих графических объектов, до таких: линия, дуга, кривая Безье и заливка замкнутых контуров. Основываясь уже на этих базовых фигурах, можно строить производные фигуры, комбинируя базовые. В рамках примитива существует возможность задания прозрачности цвета в диапазоне [0...255], где '0' — полная прозрачность.
Таблица. Набор дополнительных свойств/атрибутов примитива "Элементарная фигура (ElFigure)"
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: | |||
value | Value | 21 | Contents of the line. |
view | View | 22 | View of the editing line:
|
cfg | Configuration | 23 | Configuration of the line. Format of the value of the field for different views of the lines:
|
confirm | Confirm | 24 | Enable the confirming mode. |
font | Font | 25 | Font name in the form "{family} {size} {bold} {italic} {underline} {strike}", where:
Examples:
|
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:
|
img | Image | 22 | Image on the button. Image name in the view [{src}:]{name}, where:
Examples:
|
color | Color | 23 | Color of the button. Color name form "{color}[-{alpha}]", where:
Examples:
|
colorText | Color:text | 27 | Color of the text (details above). |
mode | Mode | 24 | Operation mode of the button:
|
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:
|
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:
|
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:
|
1.3 Элемент текста (Text)
Данный примитив предназначен для вывода простого и HTML текста, используемого в роли меток и различных подписей. С целью создания декоративных оформлений, примитив поддерживает обвод текста рамкой.
Таблица. Набор дополнительных свойств/атрибутов примитива "Элемент текста (Text)"
Идентификатор | Имя | Номер | Значение |
---|---|---|---|
backColor | Фон: цвет | 20 |
Фоновый цвет. Имя цвета в виде "{color}[-{alpha}]", где:
Примеры:
|
backImg | Фон: изображение | 21 |
Фоновое изображение. Имя изображения в виде "[{src}:]{name}", где:
Примеры:
|
bordWidth | Граница: ширина | 22 | Ширина бордюра. |
bordColor | Граница: цвет | 23 | Цвет бордюра (детальнее в атрибуте 20). |
bordStyle | Граница: стиль | 24 | Стиль бордюра: "Нет" (0), "Точечный" (1), "Пунктирный" (2), "Сплошной" (3), "Двойной" (4), "Канавка" (5), "Кромка" (6), "Вдавлен" (7), "Выступающий" (8). |
font | Шрифт | 25 |
Имя шрифта в виде "{family} {size} {bold} {italic} {underline} {strike}", где:
Примеры:
|
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:
|
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:
Examples:
|
backImg | Background: image | 21 | Background image. The image name in the view "[{src}:]{name}", where:
Examples:
|
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:
Examples:
|
type | Type | 27 |
Media type:
|
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}]", где:
Примеры:
|
backImg | Фон: изображение | 21 |
Фоновое изображение. Имя изображения в виде "[{src}:]{name}", где:
Примеры:
|
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}", где:
Примеры:
|
valArch | Архиватор значений | 38 | Архиватор значений в виде "{МодульАрхивов}.{IdАрхиватора}". |
valsForPix | Значений на пиксель | 42 | Количество значений на пиксель. Увеличить для расширения точности экспорта на больших интервалах времени. |
parNum | Количество параметров | 39 | Количество параметров, отображаемых на одном тренде. |
Атрибуты типа: "График" | |||
sclHorPer | Шкала: размер гор. решетки, секунды | 43 | Фиксированный период решётки горизонтальной шкалы — отключает автоматическое вычисление периода решётки. Активируется если количество периодов на общий размер более двух и размер одного периода не менее 15 пикселей. |
Индивидуальные атрибуты параметров | |||
prm{X}addr | Параметр {X}: адрес | 50+10*{X} |
Полный адрес к атрибуту параметра X DAQ или архиву.
Пример:
|
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}]", где:
Примеры:
|
backImg | Фон: изображение | 21 |
Фоновое изображение. Имя изображения в виде "[{src}:]{name}", где:
Примеры:
|
font | Шрифт | 22 |
Имя шрифта в виде "{family} {size} {bold} {italic} {underline} {strike}", где:
Примеры:
|
headVis | Заголовок видим | 23 | Видимость заголовка таблицы. |
time | Время, секунды | 24 | Текущее время, секунды. |
tSize | Размер, секунды | 25 | Размер запроса данных, секунды. Установить значение в '0' для получения всех нарушений, для "lev" < 0. |
trcPer | Период слежения, секунды | 26 | Режим и периодичность слежения. |
arch | Архиватор | 27 | Архиватор сообщений в виде "{МодульАрхивов}.{IdАрхиватора}". |
tmpl | Шаблон | 28 |
Шаблон категории или регулярное выражение "/{re}/". Для шаблона зарезервированы символы:
|
lev | Уровень | 29 | Уровень сообщений. Установите значение < 0 для получения текущих нарушений. |
viewOrd | Порядок отображения | 30 | Порядок отображения: "По времени", "По уровню", "По категории", "По сообщению", "По времени (обратно)", "По уровню (обратно)", "По категории (обратно)", "По сообщению (обратно)". |
col | Показать колонки | 31 |
Список видимых и порядок колонок, разделённый символом ';'. Предусматриваются колонки:
|
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}", где:
Примеры:
|
bTime | Время: начало | 24 | Время начала документа, секунды. |
time | Время: текущее | 23 | Время генерации документа, секунды. Записать время для генерации документа от этой точки или нуль для перегенерации. |
process | В процессе | 27 | Признак процесса формирования документа отдельным потоком. |
n | Размер архива | 25 | Количество документов или глубина архива. |
Атрибуты включеного режима архивирования | |||
aCur | Архив: курсор: текущий | - | Позиция текущего документа в архиве. Запись значения <0 производит архивацию текущего документа. |
vCur | Архив: курсор: вид | - |
Текущий визуализируемый документ архива. Запись значения:
|
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" при разборе сообщений архива сообщений:
|
Специальные теги | |
Специальные атрибуты стандартных тегов | |
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}]", где:
Примеры:
|
backImg | Фон: изображение | 21 |
Фоновое изображение. Имя изображения в виде "[{src}:]{name}", где:
Примеры:
|
bordWidth | Граница: ширина | 22 | Ширина бордюра. |
bordColor | Граница: цвет | 23 | Цвет бордюра (детальнее в атрибуте 20). |
bordStyle | Граница: стиль | 24 | Стиль бордюра: "Нет", "Точечный", "Пунктирный", "Сплошной", "Двойной", "Канавка", "Кромка", "Вдавлен", "Выступающий". |