Визуальные компоненты: различия между версиями

Материал из Intellex
Перейти к навигации Перейти к поиску
 
(не показано 11 промежуточных версий этого же участника)
Строка 1: Строка 1:
== Визуальные компоненты ==
== Окно (window) ==
Родительский элемент для всех визуальных элементов. Соответствует окну в терминах операционной системы.
[[Файл:Окно.png|без|обрамить]]
'''Свойства'''
{| class="wikitable"
|'''Название атрибута'''
|'''Тип данных'''
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
|caption
|строка
|да
|
| colspan="1" |да
| colspan="1" |да
|Заголовок окна
|-
| colspan="1" |resize
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |<nowiki>1|true</nowiki>
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |<nowiki>Допускает ли окно возможность изменения его размеров пользователем. Доступно начиная с XBF_3 и XMModule_3.0.xsd. Возможные значения "1"|"true" или "0"|"false" (независимы от регистра).</nowiki>
 
Примечание: если при обращении к этому атрибуту его значение в строковом виде равно "1" или "true", то оно принимается за true, в случае любых других значений включая пустую строку или NULL оно принимается за false.
|-
| colspan="1" |focusedControl
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Название компонента внутри текущего окна, на котором должен быть установлен фокус по умолчанию
|-
|onclose
|строка
|нет
|
|нет
|нет
|Действие, выполняемое при закрытии окна, не являющегося главным
|}


=== Контейнер объектов (container) ===
== Контейнер объектов (container) ==
Предназначен для задания единого способа отображения визуальных компонентов.
Предназначен для задания единого способа отображения визуальных компонентов и позволяющий инкапсулировать в себе объекты других типов.
[[Файл:Контейнер объектов.png|без|обрамить]]
[[Файл:Контейнер объектов 1.png|без|обрамить]]
'''Свойства'''  
'''Свойства'''  
{| class="wikitable"
{| class="wikitable"
Строка 52: Строка 98:
|}
|}


=== Вкладки (tabsheet) ===
== Вкладки (tabsheet) ==
Вкладка — это визуальный элемент, который позволяет создавать множество вкладок, для размещения на них визуальных элементов..
Вкладка — это визуальный элемент, который позволяет создавать множество вкладок, для размещения на них визуальных элементов.
 
[[Файл:Вкладка 2.png|без|обрамить]]
==== Наследование ====
'''Свойства'''
Наследует все атрибуты от '''<визуальные элементы>'''
 
==== Структура ====
{| class="wikitable"
|
<tabsheet>
<tab>
<nowiki> </nowiki>      ...
<nowiki> </nowiki>  </tab>
</tabsheet>
|}
 
==== Свойства ====
{| class="wikitable"
{| class="wikitable"
|'''Название атрибута'''
|'''Название атрибута'''
Строка 143: Строка 176:
|}
|}


=== Родительский тег ===
== Панель кнопок (toolbar) ==
Родительский тег: '''container''', '''window''', '''tab'''.
Панель кнопок - визуальный элемент, который позволяет разместить в себе группу кнопок.
 
[[Файл:Панель кнопок 2.png|без|обрамить]]
=== Дочерний тег ===
'''Свойства'''
Дочерний тег: '''tab'''
 
=== Панель кнопок (toolbar) ===
 
==== Описание ====
Компонент для отображения панели кнопок. Панель кнопок может быть только горизонтальной и должна располагаться в контейнере с вертикальным направлением размещения элементов.
 
==== Наследование ====
Наследует все атрибуты от '''<визуальные элементы>'''
 
==== Структура ====
{| class="wikitable"
|
<toolbar>
    <nowiki><button /></nowiki>
    <separator />
</toolbar>
|}
 
==== Свойства ====
{| class="wikitable"
{| class="wikitable"
|'''Название атрибута'''
|'''Название атрибута'''
Строка 186: Строка 198:
|}
|}


=== Родительский тег ===
== Кнопка (button) ==
Родительский тег: '''container''', '''window''', '''tab'''.
Позволяет добавить на панель кнопку, которую в последствие можно привязать к какому-либо действию, созданному в правилах заполнения (к примеру Апп-функция).
[[Файл:Кнопка 2.png|без|обрамить]]
'''Свойства'''
{| class="wikitable"
|'''Название атрибута'''
|'''Тип данных'''
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступен из скрипта'''
|'''Описание'''
|-
| colspan="1" |onclick
| colspan="1" |действие
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Название действия (action/actiongroup), выполняемое при нажатии на кнопку
|-
| colspan="1" |iconname
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |да
| colspan="1" |Наименование иконки из репозитория для отображения на кнопке
|-
| colspan="1" |hint
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |да
| colspan="1" |Текст всплывающей подсказки при наведении на кнопку
|}


=== Дочерний тег ===
== Текст/подпись (label) ==
Дочерний тег: '''button'''
[[Файл:Подпись.png|без|обрамить]]
 
'''Свойства'''
== Произвольный ввод ==
{| class="wikitable"
'''Произвольный ввод''' - это визуальное действие, которое позволяет пользователю заполнить поля документа произвольным значением.
|'''Название атрибута'''
 
|'''Тип данных'''
Пример отображения компонента "Произвольный ввод"
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступен из скрипта'''
|'''Описание'''
|-
| colspan="1" |onclick
| colspan="1" |действие
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Название действия (action/actiongroup), выполняемое при клике на тексте
|}


=== Основные свойства ===
== Таблица (grid) ==
Компонент для отображения табличных данных.
[[Файл:Таблица 2.png|без|обрамить]]
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
|'''Название атрибута'''
! colspan="1" |Наличие значения
|'''Тип данных'''
!Назначение
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
| colspan="1" |groupby
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |нет
| colspan="1" |Перечисление колонок курсора для их группировки через запятую (Только для Delphi)
|-
| colspan="1" |groupbox
| colspan="1" |булеан
| colspan="1" |нет
| colspan="1" |true
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |При истинном значении отображается поле для ручной группировки данных пользователем (Только для Delphi)
|-
|-
|Параметр
| colspan="1" |selectedRow
| colspan="1" |Обязательно
| colspan="1" |строка курсора
|'''Описание:''' атрибут предназначен для выбора из списка соответствующего параметра, заданного в структуре документа.
| colspan="1" |''только чтение''
 
| colspan="1" |
'''Допустимые значения''': статичная строка
| colspan="1" |нет
 
| colspan="1" |да
''Примечание: В списке содержатся только те параметры, которые соответствуют уровню блока в структуре документа.''
| colspan="1" |Позволяет получить данные из выделенной в гриде строке, дополнительно указав название колонки в курсоре. Например выражение:
{| class="wikitable"
|<code>${window.grid.selectedRow.rw_name}</code>
|}
возвращает из выделенной строки грида grid значение ячейки в колонке с именем rw_name
|-
|-
|Описание
| colspan="1" |selectedRows
| colspan="1" |Не обязательно
| colspan="1" |строка курсора
|'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
| colspan="1" |''только чтение''
 
| colspan="1" |
'''Допустимые значения:''' статичная строка
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Позволяет получить данные из выделенных в гриде строк, дополнительно указав название колонки в курсоре. Например выражение:
{| class="wikitable"
|<code>${window.grid.selectedRows.rw_name}</code>
|}
возвращает через запятую из выделенных строк грида значение ячеек в колонке с именем rw_name. В случае, когда выделена только одна строка в гриде, атрибут работает как selectedRow
|-
|-
|Назначение
| colspan="1" |selectedCell
| colspan="1" |Не обязательно
| colspan="1" |любой тип
|'''Описание:''' атрибут предназначен для описания параметра в спецификации.
| colspan="1" |''только чтение''
 
| colspan="1" |
'''Допустимые значения:''' статичная строка
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Позволяет получить данные из выделенной ячейки грида. Например выражение:
{| class="wikitable"
|<code>${window.grid.selectedCell}</code>
|}
|}
 
возвращает значение выделенной ячейки грида
=== Свойства применимости ===
|-
| colspan="1" |selectedSourceField
| colspan="1" |строка
| colspan="1" |''только чтение''
| colspan="1" |
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Название колонки в курсоре данных, соответствующей выделенной колонки грида
{| class="wikitable"
{| class="wikitable"
!Свойство
|<code>${window.grid.selectedSourceField}</code>
! colspan="1" |Наличие значения
|}
!Назначение
|-
|-
| colspan="1" |Скрывать если
| colspan="1" |selectedGroup
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут предназначен для скрытия связанного сдействием визуального элемента на форме.
| colspan="1" |''только чтение''
| colspan="1" |
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Информация о группировке. Формат:
{| class="wikitable"
|<code><group></code>


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
<code>   <!-- 0..N --></code>


* Истина - элемент скрывается на форме
<code>   <col_name>group_value</col_name></code>
* Ложь - элемент отображается
* NULL - элемент отображается


''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
<code></group></code>
|}
Например, если данные в гриде сгруппированы по колонка A и B. Осуществляется попытка провалиться в итоги, где A="Значение A", B="Значение B", то результирующая строка будет
{| class="wikitable"
{| class="wikitable"
|
|<code><group></code>
(DOC_NUM_PARAM>10) AND (DOC_LOG_PARAM = FALSE)
 
<code>   <A>Значение A</A></code>
 
<code>   <nowiki><B>Значение B</B></nowiki></code>
 
<code></group></code>
|}
|}
Не поддерживается в XM
|-
|-
| colspan="1" |Выполнять если
| colspan="1" |selectioncolumn
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на возможность изменять значение параметра при помощи визуального компонента. Выражение имеет логический тип.
| colspan="1" |''только чтение''
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Имя колонки (поля), в котором пользователь сможет осуществлять выделение галочкой.


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
<nowiki>!!! поле с таким именем должно присутствовать в датасете, а колонка с этим полем - в списке колонок грида!!!</nowiki>
|-
| colspan="1" |livecomplexheaders
| colspan="1" |булеан
| colspan="1" |нет
| colspan="1" |false
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Признак того, что в случае сложных заголовков сохраняется возможность сортировать и фильтровать по столбцам грида.


* Истина - элемент доступен для редактирования
Если этот атрибут равен "true", то значение атрибута numerate игнорируется и считается равным "false".
* Ложь - элемент не доступен для редактирования
|-
* NULL - элемент доступен
| colspan="1" |columnfiltereditemslist
| colspan="1" |булеан
| colspan="1" |нет
| colspan="1" |false
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |При фильтрации в фильтрах колонок грида присутствуют только значения видимые в результате применения фильтров по другим колонкам(иначе фильтры колонок содержат все значения).
|-
| colspan="1" |groupHeaderLineCount
| colspan="1" |число
| colspan="1" |нет
| colspan="1" |1
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Количество строк в заголовке группы.
|-
| colspan="1" |cansort
| colspan="1" |булеан
| colspan="1" |нет
| colspan="1" |true
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Дать возможность пользователю сортировать данные.
|-
| colspan="1" |expandGroups
| colspan="1" |булеан
| colspan="1" |нет
| colspan="1" |false
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Развернуть группировки.
|-
| colspan="1" |checkedRows
| colspan="1" |строка курсора
| colspan="1" |''только чтение''
| colspan="1" |
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Позволяет получить данные из строк в гриде, отмеченными галочками, дополнительно указав колонку название колонки в курсоре. Значения будут перечислены через запятую.


''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
Например выражение:
{| class="wikitable"
{| class="wikitable"
|
|<code>${window.grid.checkedRows.rw_id}</code>
IF(DOC_NUM_PAR = 10, TRUE, FALSE)
|}
|}
|}
для отмеченных строк грида rw_id = 10 и rw_id=20 вернет "10,20"


=== Зависимости визуального компонента от типа параметра ===
Отмеченной строкой грида является та строка, у которой значение колонки из selectioncolumn равно истине
{| class="wikitable"
|-
!Тип
| colspan="1" |rowstyle
!Описание
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |"Стиль строки" - Название колонки, содержащей информацию о раскраске строки таблицы. Формат раскраски описан в статье (Выделение цветом строк в окне фильтра) - '''''TTTTTT$BBBBBB$SSSS'''''
|-
| colspan="1" |selectedRowStyle
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |"Стиль выделенной строки" - Название колонки, содержащей информацию о раскраске выделенной строки таблицы. Формат раскраски описан в статье (Выделение цветом строк в окне фильтра) - '''''TTTTTT$BBBBBB$SSSS'''''
|-
| colspan="1" |minRows
| colspan="1" |число
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Минимальное число строк на странице
|-
|-
|Строка
| colspan="1" |maxRows
|Позволяет ввести в компонент строку
| colspan="1" |число
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Максимальное число строк на странице
|-
|-
| colspan="1" |Число
| colspan="1" |selectedColumnName
| colspan="1" |Позволяет вводить в компонент только числовое значение
| colspan="1" |строка
| colspan="1" |''только чтение''
| colspan="1" |
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Название активной колонки (которое отображается в шапке грида)
|-
|-
| colspan="1" |Дата
| colspan="1" |selectedColumnNameWithBands
| colspan="1" |Позволяет выбрать дату или ввести с клавиатуры
| colspan="1" |строка
| colspan="1" |''только чтение''
| colspan="1" |
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Для сложных шапок - последовательность названий колонок, в которые входит активная, начиная сверху, через запятую.
 
Пример: Верхний бенд, средний бенд, название колонки.
|-
|-
| colspan="1" |Дата и время
| colspan="1" |selectedColumnBand(xx)
| colspan="1" |Позволяет выбрать дату со временем
| colspan="1" |строка
| colspan="1" |''только чтение''
| colspan="1" |
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Возвращает функцию для расчета сложных шапок - названий бендов. Для получения последовательности бендов заданного уровня, необходима запись типа ${eval(windowName.gridName.selectedColumnBand,xx)}, где windowName - имя формы, gridName - имя грида, xx - номер уровня (считается от колонки вверх).
|-
|-
|Логический
| colspan="1" |exportCaption
|Позволяет выбрать значение True или False
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |нет
| colspan="1" |Текст в шапке листа Excel при экспорте.
|}
|}
'''Обработчики событий'''
{| class="wikitable"
|'''Название атрибута'''
|'''Тип данных'''
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
| colspan="1" |ondrilldown
| colspan="1" |действие (action/actiongroup)
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |нет
| colspan="1" |Название действия, выполняемое при двойном щелчке на строк. Если столбцу грида, в ячейке которого был выполнен двойной щелчток мышью также содержит атрибут ondrilldown, то выполняется действие, назначенное столбцу.
|-
| colspan="1" |onrowselect
| colspan="1" |действие (action/actiongroup)
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |нет
| colspan="1" |Название действия, выполняемое при смене активной строки грида.


== Отображение значения ==
Действие также выполняется при инициализации грида, так как в этот момент его первая строка становится активной.
'''Отображение значения''' - это визуальное действие, которое позволяет пользователю отображать значение поля документа
|-
| colspan="1" |onrowclick
| colspan="1" |действие (action/actiongroup)
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |нет
| colspan="1" |Название действия, выполняемое при нажатии на строку грида.
|}


== Группа колонок грида (colgroup) ==
Объединяет несколько подряд идущих колонок в одну визуальную группу.
[[Файл:Группа колонок 2.png|без|обрамить]]
'''Свойства'''
{| class="wikitable"
|'''Название атрибута'''
|'''Тип данных'''
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
|caption
|строка
|да
|
| colspan="1" |да
| colspan="1" |нет
|Название группы колонок
|}


Пример отображения компонента "Произвольный текст"
== Колонка (column) ==
 
Описывает визуальное представление колонки грида и связывает колонку с курсором данных.
=== Основные свойства ===
[[Файл:Колонка 2.png|без|обрамить]]
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
|'''Название атрибута'''
! colspan="1" |Наличие значения
|'''Тип данных'''
!Назначение
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
|caption
|строка
|да
|
| colspan="1" |да
| colspan="1" |нет
|Название колонки
|-
| colspan="1" |sourcefield
| colspan="1" |строка
| colspan="1" |да
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Название отображаемой колонки курсора
|-
|-
|Параметр
| colspan="1" |displayformat
| colspan="1" |Обязательно
| colspan="1" |перечислимый
|'''Описание:''' атрибут предназначен для выбора из списка соответствующего параметра, заданного в структуре документа.
| colspan="1" |
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Формат отображения данных:


'''Допустимые значения:''' статичная строка. В списке содержатся только те параметры, которые соответствуют уровню блока в структуре документа.
* currency - отображение денег
* number - отображение произвольного числа
* date - дата
* datetime -дата со временем
* check - булеан в виде checkbox
* string - строка (в разработке)
* icon - иконка по идентификатору
* checkicon - кликабельная иконка - при клике на нее значение поля меняется на +1 и иконка меняется на следующую из списка icons (если список исчерпан, то с начала списка и значение поля равно 0)
|-
|-
|Описание
| colspan="1" |summary
| colspan="1" |Не обязательно
| colspan="1" |строка
|'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
| colspan="1" |
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Формула для расчета итогов и подытогов колонки. '''Формулы 1-го рода''' - агрегирующие функции:


'''Допустимые значения:''' статичная строка
* sum() - просуммировать значения текущей колонки. Применяется для типов данных: число (деньги)
* min() - минимальное значение текущей колонки. Применяется для типов данных: число (деньги), дата
* max() - максимальное значение текущей колонки. Применяется для типов данных: число (деньги), дата
* avg() - среднее значение значений текущей колонки. Применяется для типов данных: число (деньги)
* count() - количество строк в текущей колонке. Применяется для всех типов данных
* countdistinct() - количество строк с уникальными значениями в текущей колонке. Применяется для всех типов данных
* countnotempty() - количество строк с не пустыми значениями в текущей колонке. Применяется для всех типов данных


По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
'''Формулы 2-го рода''' - агрегирующие функции по произвольным колонкам курсора:
|-
|Назначение
| colspan="1" |Не обязательно
|'''Описание:''' атрибут предназначен для описания параметра в спецификации.


'''Допустимые значения:''' статичная строка
* sum(название колонки курсора) - просуммировать значения заданной колонки (суммирует значения только из заданных в гриде колонок)
|}
* min(название колонки курсора) - минимальное значение заданной колонки
* max(название колонки курсора) - максимальное значение заданной колонки
* avg(название колонки курсора) - среднее значение значений заданной колонки
* count(название колонки курсора) - количество строк в заданной колонке
* countdistinct(название колонки курсора) - количество строк с уникальными значениями в заданной колонке
* countnotempty() - количество строк с не пустыми значениями в текущей колонке. Применяется для всех типов данных
* group(название колонки курсора) - используется для условия подсчёта подытогов. Подытог рассчитывается только для данных, группируемых по колонке, указанной в group.


=== Свойства применимости ===
'''Формулы 3-го рода''' - формулы первого и второго рода и операторы для $-выражений. Например:
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Скрывать если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
sum(название колонки курсора) + min() - сумма значений заданной колонки плюс минимальное значение в текущей колонке.


* Истина - элемент скрывается на форме
'''XM-формула'''
* Ложь - элемент отображается и недоступен для редактирования значения.
* NULL - элемент отображается и недоступен для редактирования значения.


''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
Есть возможность так же использовать xm-формулы, они обязательно должны быть обернуть в $ выражение - '''${Текст формулы}'''
{| class="wikitable"
|
(DOC_NUM_PARAM>10) AND (DOC_LOG_PARAM = FALSE)
|}
|-
|-
| colspan="1" |Выполнять если
| colspan="1" |summaryformat
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.
| colspan="1" |
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Формат отображения данных итогов и подытогов колонки:


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
* currency - отображение денег
* number - отображение произвольного числа


* Истина - элемент отображается и недоступен для редактирования
'''Примечание''': если в summary колонки находится формула 2-го или 3-го рода (см. summary), то необходимо определить формат итога
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования


''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
для значения формулы с помощью summaryformat.
{| class="wikitable"
|-
|
| colspan="1" |headerstyle
IF(DOC_NUM_PAR = 10, TRUE, FALSE)
| colspan="1" |стиль
|}
| colspan="1" |
|}
| colspan="1" |
 
| colspan="1" |да
=== Зависимости визуального компонента от типа параметра ===
| colspan="1" |нет
{| class="wikitable"
| colspan="1" |Стиль шапки колонки. Фактически используется только для задания ширины колонки.
!Тип
|-
!Описание
| colspan="1" |contentstyle
| colspan="1" |стиль
| colspan="1" |
| colspan="1" |
| colspan="1" |да
| colspan="1" |нет
| colspan="1" |Стиль данных по колонке. Никак не влияет на внешний вид колонки. Добавлен на случай будущего расширения стилей дополнительными атрибутами.
|-
|-
|Строка
| colspan="1" |descriptionfunc
|Позволяет отобразить в компонент строку
| colspan="1" |строка
| colspan="1" |
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Наименование апп-функции, для получения описания картинки
|-
|-
| colspan="1" |Число
| colspan="1" |visible
| colspan="1" |Позволяет отобразить в компонент числовое значение
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |<nowiki>1|true</nowiki>
| colspan="1" |да
| colspan="1" |нет
| colspan="1" |<nowiki>Видимость столбца. Возможные значения "1"|"true" или "0"|"false" (независимы от регистра).</nowiki>
 
Примечание: если при обращении к этому атрибуту его значение в строковом виде равно "1" или "true", то оно принимается за true, в случае любых других значений включая пустую строку или NULL оно принимается за false.
|-
|-
| colspan="1" |Дата
| colspan="1" |widthinchars
| colspan="1" |Позволяет отобразить в компонент дату
| colspan="1" |число
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Начальная ширина колонки в размере равном указанному количеству латинских символов "a"
|-
|-
| colspan="1" |Дата и время
| colspan="1" |icons
| colspan="1" |Позволяет отобразить в компонент дату со временем
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Список идентификаторов системных иконок которые последовательно будут отображаться в поле типа checkicon при изменении значения поля. (Первая иконка списка отображается при значении поля 0, вторая 1 итд)
|-
|-
|Логический
| colspan="1" |cellstyle
|Позволяет отобразить в компонент значение True или False(в чекбоксе)
| colspan="1" |строка
|}
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Название колонки, содержащей информацию о раскраске ячейки в колонке таблицы.
 
Значением в поле колонки стиля должна быть строка, содержащая json с настройками стилизации ячейки в строке.
 
Поддерживаются следующие параметры стилизации:
 
bgcolor - цвет заливки ячейки
 
textcolor - цвет текста ячейки


== Выбор из списка ==
textalign - кастомное выравнивание содержимого ячейки по горизонтали (  left, center, right )
'''Выбор из списка''' - это визуальное действие, которое разрешает пользователю заполнить поле документа одним значением из списка допустимых значений.


Пример отображения компонента "Выбор из списка"
fractionDigits - количество знаков после запятой для ячеек с типом "number" - (параметр числовой - то есть "fractionDigits": 2 , а не "2")


=== Основные свойства ===
bold (true/false) - жирный шрифт
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|Тип выбора
| colspan="1" |Обязательно
|'''Описание:''' позволяет настроить выпадающий список для выбора значение из грида.


'''Допустимые значения''':
italic (true/false) - курсив


* Из грида. Позволяет использовать в качестве списка данные из таблицы своего документа.
underline (true/false) - подчеркивание
* Из апп-функции. Позволяет использовать апп-функцию, при выборе значения из выпадающего списка. Апп-функция должна возвращать курсор.
* Из локального справочника. Позволяет использовать локальные справочники в качестве входных параметров.
* Из общего справочника. Позволяет использовать общие справочники в качестве входных параметров.


''По умолчанию установлено значение "Из апп-функции"''
strikethrough (true/false) - перечеркивание
|-
|Параметр
| colspan="1" |Обязательно
|'''Описание:''' атрибут предназначен для указания параметра, в которых будет сохранен идентификатор из справочника


'''Допустимые значения''': число
Например '{"bgcolor": "#00ff00", "textcolor": "#ffff00", "underline": true, "strikethrough": false}'


Важно, чтобы значением свойств bold, italic, underline и strikethrough было именно булево значение true или false, а не строки "true" или "false"
|-
| colspan="1" |headerLineBreak
| colspan="1" |булеан
| colspan="1" |
| colspan="1" |false
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Признак переноса строки в заголовке колонки.
|-
|-
| colspan="1" |Описание
| colspan="1" |headerTextAlign
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
| colspan="1" |
| colspan="1" |left
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Выравнивание текста в заголовке колонки:


'''Допустимые значения:''' статичная строка
* left - по левому краю;
* center - по центру;
* right - по правому краю;
* justify - по ширине.
|-
|-
| colspan="1" |Назначение
| colspan="1" |withDischarges
| colspan="1" |Не обязательно
| colspan="1" |булеан
| colspan="1" |'''Описание:''' атрибут предназначен для описания параметра в спецификации.
| colspan="1" |нет
 
| colspan="1" |false
'''Допустимые значения:''' статичная строка
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Разделение на разряды. Учитывается для колонок с форматом отображения число или деньги.
|}
|}
Свойства применимости
'''Обработчики событий'''
{| class="wikitable"
{| class="wikitable"
!Свойство
|'''Название атрибута'''
! colspan="1" |Наличие значения
|'''Тип данных'''
!Назначение
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
|-
| colspan="1" |Скрывать если
| colspan="1" |ondrilldown
| colspan="1" |Не обязательно
| colspan="1" |действие (action/actiongroup)
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.
| colspan="1" |
 
| colspan="1" |
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
| colspan="1" |да
 
| colspan="1" |нет
* Истина - элемент скрывается на форме
| colspan="1" |Название действия при проваливании в ячейку. Информацию о ячейке можно получить из атрибутов selectedCell, selectedSourceField, selectedRow
* Ложь - элемент отображается и недоступен для редактирования значения.
|-
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
| colspan="1" |ondrillsummary
| colspan="1" |действие (action/actiongroup)
| colspan="1" |
| colspan="1" |
| colspan="1" |да
| colspan="1" |нет
| colspan="1" |Название действия при проваливании в строку итогов. Информацию о группировки можно получить из атрибута selectedGroup
|-
|-
| colspan="1" |Выполнять если
| colspan="1" |onchangevalue
| colspan="1" |Не обязательно
| colspan="1" |действие (action/actiongroup)
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.
| colspan="1" |
 
| colspan="1" |
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
| colspan="1" |да
 
| colspan="1" |нет
* Истина - элемент отображается и недоступен для редактирования
| colspan="1" |Для displayformat "check" и "checkicon" - определяет действие которое будет вызываться при смене значения в ячейке (клике на чекбокс/иконку).
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования


''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
Вызывается после установки нового значения в гриде.
|}
|}
 
'''Форматирование данных'''
=== Свойства для типа выбора - "из грида" ===
Данные свойства предназначены, когда требуется заполнить выпадающий список на основе колонок грида.
{| class="wikitable"
{| class="wikitable"
!Свойство
!Тип данных/displayformat
! colspan="1" |Наличие значения
! colspan="1" |Выравнивание
!Назначение
!Способ форматирования
|-
|Число/number
| colspan="1" |справа
|
* В целой части используются разделители тысячных в виде пробелов
* Дробная часть отображается только при ее наличии, т.е. она не равна 0
* Дробная часть может иметь длину не более 6 знаков
* Если дробная часть имеет больше 6 знаков, она округляется по правилам математики
* Дробная часть не должная содержать в качестве последних символов нули
|-
|-
| colspan="1" |Имя грида
| colspan="1" |Дата/date
| colspan="1" |Обязательно
| colspan="1" |по центру
| colspan="1" |'''Описание:''' атрибут предназначен для выбора грида из списка, который будет использоваться для "Выпадающего списка"
| colspan="1" |Формат отображения: dd.mm.yyyy hh24:mi:ss.


'''Допустимые значения:''' статичная строка
Время отображается только, если оно не равно 00:00:00
|-
| colspan="1" |/datetime
| colspan="1" |по центру
| colspan="1" |Формат отображения: dd.mm.yyyy hh24:mi:ss
|-
| colspan="1" |/currency
| colspan="1" |справа
| colspan="1" |
* В целой части используются разделители тысячных в виде пробелов
* Дробная часть всегда отображается и имеет два знача после запятой. Например, для целый чисел дробная часть равна "00"
|-
|-
| colspan="1" |Условия выбора строк
| colspan="1" |Строка/string (в разработке)
| colspan="1" |Не обязательно
| colspan="1" |слева
| colspan="1" |'''Описание:''' атрибут предназначен для задания выражения, при котором будут отображаться строки в выпадающем списке.
| colspan="1" |Данные, отличные от строки, форматируются в строку согласно правилам "Способ форматирования" для каждого типа данных. Исключение для чисел, при форматировании в строку для них не используются разделители тысячных
 
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
 
* Истина - выбор строк разрешен
* Ложь - выбор строк запрещен
* NULL - выбор строк разрешен
 
''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
|}
|}


=== Свойства для типа выбора - "из апп-функции" ===
== Числовое поле (numedit) ==
Данные свойства предназначены, когда требуется заполнить выпадающий список с помощью апп-функции
Компонент для ввода числовых данных.
[[Файл:Числовое поле 2.png|без|обрамить]]
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
|'''Название атрибута'''
! colspan="1" |Наличие значения
|'''Тип данных'''
!Назначение
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
|-
|Апп-функция
| colspan="1" |displayformat
| colspan="1" |Не обязательно
| colspan="1" |перечислимый
|'''Описание:''' Атрибут предназначен для выбора апп-функции, по которой будет выбираться значение из списка. Апп-функция должны иметь тип 1, т.е. возвращать курсор.
| colspan="1" |нет
| colspan="1" |number
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Формат отображения данных:


'''Допустимые значения:'''  статичная строка
* currency - отображение денег
* number - отображение произвольного числа
|-
|-
| colspan="1" |Начать поиск с
| colspan="1" |totalDigits
| colspan="1" |Не обязательно
| colspan="1" |число
| colspan="1" |'''Описание:''' атрибут предназначен для задания минимального количества символов, после ввода которых будет осуществляться поиск. Значение может принимать только числовой тип
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Допустимая длина числа


'''Допустимые значения:''' число
Мин. - 1 (oracle), макс. - 38 (oracle)


''Примечание: если выражение не задано, то условие по умолчанию поиск осуществляется сразу''
Если значение не задано, оно считается равным максимальному
|-
|-
| colspan="1" |Входной параметр
| colspan="1" |fractionDigits
| colspan="1" |Обязательно для(Наименование\Идентификатор\Код)
| colspan="1" |число
| colspan="1" |'''Описание:''' предназначен для передачи входных параметров
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Допустимая длина дробной части


'''Допустимые значения:''' статичная строка
Мин. - 1 (oracle), макс. - 10 (oracle)
|-
| colspan="1" |Значение
| colspan="1" |Обязательно для(Наименование\Идентификатор\Код)
| colspan="1" |'''Описание:''' предназначен для указания значения(выражения)


'''Допустимые значения:''' статичная строка
Если значение не задано, оно считается равным максимальному
|-
|-
| colspan="1" |Параметр документа
| colspan="1" |withDischarges
| colspan="1" |Обязательно(для Идентификатора и Наименования)
| colspan="1" |булеан
| colspan="1" |'''Описание:''' атрибут предназначен для указания выходных параметров при выборе значения я из списка
| colspan="1" |нет
 
| colspan="1" |true
'''Допустимые значения:''' статичная строка
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Разделить число на разряды
|-
|-
| colspan="1" |Описание колонки
| colspan="1" |incDecButtonsNeeded
| colspan="1" |Не обязательно
| colspan="1" |булеан
| colspan="1" |'''Описание:''' атрибут задает название для колонки(в случае если используется multisublistchoise) В других случаях название не влияет на компонент
| colspan="1" |нет
 
| colspan="1" |false
'''Допустимые значения:''' статичная строка
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Управляет отображением кнопок увеличения\уменьшения значения на 1.
|}
|}


=== Свойства для типа выбора - "из локального справочника" ===
== Текстовое поле ввода (edit) ==
Компонент для ввода текстовых данных.
[[Файл:Текстовое поле 2.png|без|обрамить]]
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
|'''Название атрибута'''
! colspan="1" |Наличие значения
|'''Тип данных'''
!Назначение
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
| colspan="1" |password
| colspan="1" |булеан
| colspan="1" |нет
| colspan="1" |false
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |При истинном значении текст отображается в зашифрованном виде
|-
|-
|Справочник
| colspan="1" |maxlength
| colspan="1" |Не обязательно
| colspan="1" |число
|'''Описание:''' атрибут предназначен для выбора локального справочника
| colspan="1" |нет
| colspan="1" |0
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Наибольшая возможная длина текста. Если введено число символов больше, чем заданная максимальная длина, то текст обрезается до размера, указанного в maxlength.


'''Допустимые значения:''' название справочника
В случае отсутствия этого атрибута или его нулевого или отрицательного значения длина текста ничем не ограничена.
|-
|-
| colspan="1" |Параметр документа
| colspan="1" |immediateChange
| colspan="1" |Обязательно(для Идентификатора и Наименования)
| colspan="1" |булеан
| colspan="1" |'''Описание:''' атрибут предназначен для указания выходных параметров при выборе значения я из списка
| colspan="1" |нет
 
| colspan="1" |false
'''Допустимые значения:''' статичная строка
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Требование XM-документу реагировать на каждое изменение соджержимого строки ввода и немедленно производить соответствующие расчеты.
|-
|-
| colspan="1" |Описание колонки
| colspan="1" |mask
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут задает название для колонки(в случае если используется multisublistchoise) В других случаях название не влияет на компонент
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Маска ввода. Содержит шаблон, по которому будет форматировано значение поля.


'''Допустимые значения:''' статичная строка
Шаблоны бывают двух видов - маска и обычное регулярное выражение.
|}


=== Свойства для типа выбора - "общего справочника" ===
1) Шаблон типа "Маска":
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|Справочник
| colspan="1" |Не обязательно
|'''Описание:''' Атрибут предназначен для выбора общего справочника


'''Допустимые значения:''' статичная строка
0 - любое число
|-
| colspan="1" |Параметр документа
| colspan="1" |Обязательно(для Идентификатора и Наименования)
| colspan="1" |'''Описание:''' Атрибут предназначен для указания выходных параметров при выборе значения я из списка


'''Допустимые значения:''' статичная строка
a (латинская) - любая буква
|-
| colspan="1" |Описание колонки
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' Атрибут задает название для колонки(в случае если используется multisublistchoise) В других случаях название не влияет на компонент


'''Допустимые значения:''' статичная строка
<nowiki>*</nowiki> - любой символ
|}


== Апп-функция ==
[] - все, что внутри, к вводу необязательно
Апп-функция - это действие, которое позволяет изменять поля документа через БД. Поля документа передаются в апп-функцию в качестве входных и выходных параметров.


Пример отображения компонента "Апп-функция"
{} -все, что внутри, останется в value у поля. Используется для тех символов, которые уже являются частью маски изначально - например, знаки пунктуации. Так, данные, введенные по маске 000-000 не будут в итоге содержать дефиса (он будет добавляться только в саму маску поля, без передачи в БД\хранилище при сохранении), а по 000{-}000 - будут.


=== Основные свойства ===
Если какой-то из вышеперечисленных символов нужно вставить буквально, его надо экранировать обратным слешем - \ (то есть \0 позволит только ноль вставить).
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|Апп-функция
| colspan="1" |Обязательно
|'''Описание:''' позволяет выбрать имя апп-функции


'''Допустимые значения''': статичная строка, для апп-функции с CALL_TYPE = 1 или 2
|-
|Выполняется
| colspan="1" |Обязательно
|'''Описание:''' атрибут позволяет указать, каким образом будет выполняться апп-функция(автоматически или по нажатию на кнопку)


'''Допустимые значения''':
Также существует возможность вставить в шаблон типа "Маска" регулярное выражение с квантификатором. Само регулярное выражение должно записываться в круглых скобках, например:


* Автоматически - означает, что данная апп-функция будет выполняться всегда(если условия выполнения не запрещают)
([A-Z])
* По желание пользователя - в этом случае, пользователю предоставляется возможность запустить выполнение данной апп-функции с помощью кнопки, отображаемой на форме документа


''По умолчанию всегда установлено значение "Автоматически"''
Такая запись будет соответствовать одному символу. Если символов несколько, то добавляется квантификатор в круглых скобках, следующих за скобками с RegExp:
|-
| colspan="1" |Описание
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.


'''Допустимые значения:''' статичная строка
([A-Z])(4) - нужно ввести строго 4 символа.
|-
| colspan="1" |Назначение
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для описания параметра в спецификации.


'''Допустимые значения:''' статичная строка
([A-Z])(1,4) - минимум один, максимум 4.
|}


=== Свойства применимости ===
Квантификатор не может быть открытый, т.к. шаблон типа "Маска" подразумевает точное указание количества символов.
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Скрывать если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
Если необходимо сделать круглую скобку частью маски, то ее нужно экранировать обратным слешем - \. Пример:


* Истина - элемент скрывается на форме
\(([A-Z])(1, 4)\) - ввод пользователя будет обрамлен круглыми скобками.
* Ложь - элемент отображается и недоступен для редактирования значения.
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
|-
| colspan="1" |Выполнять если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
2) Шаблон типа "Регулярное выражение":


* Истина - элемент отображается и недоступен для редактирования
RegExp нужно вводить в поле как обычное регулярное выражение, но оно должно быть таким, чтобы поддерживался промежуточный ввод. Например:
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования


''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
^\d{1,2}\/\d{1,2}\/\d{4}$ - не поддерживается, т.к. предполагает одновременное наличие минимум 6 символов.
|}


== Изменить весь документ ==
^\d{0,2}\/?\d{0,2}\/?\d{0,4}$ - поддерживается, т.к. допускает промежуточный ввод.
Изменить весь документ - это действие, которое позволяет одной операцией изменить все поля документа включая вложенные таблицы.


=== Основные свойства ===
^\d{1,2}\/?\d{0,2}\/?\d{0,4}$ - тоже поддерживается, т.к. первым символом будет введено число - и строка будет соответствовать RegExp.
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|Апп-функция
| colspan="1" |Обязательно
|'''Описание:''' позволяет выбрать имя апп-функции, которая будет использоваться для изменения документа


'''Допустимые значения''': статичная строка, для апп-функции с CALL_TYPE = 2
Для правильной интерпретации следует добавлять в начало выражения - ^, а в конец - $.
|-
|Выполняется
| colspan="1" |Обязательно
|'''Описание:''' атрибут позволяет указать, каким образом будет выполняться апп-функция(автоматически или по нажатию на кнопку)


'''Допустимые значения''':


* Автоматически - означает, что данная апп-функция будет выполняться всегда(если условия выполнения не запрещают)
В целом, шаблон типа "Маска" следует использовать для более строгих форматов, а RegExp - для более открытых (только цифры, буквы и т.п.)
* По желание пользователя - в этом случае, пользователю предоставляется возможность запустить выполнение данной апп-функции с помощью кнопки, отображаемой на форме документа


''По умолчанию всегда установлено значение "По желанию пользователя"''
|-
|-
| colspan="1" |Описание
| colspan="1" |maskType
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
| colspan="1" |нет
| colspan="1" |pattern
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Тип маски ввода. Содержит строку, по которой определяется тип маски - шаблон библиотеки IMask или RegExp.
|}
 
== Выбор даты (datepicker) ==
Компонент ввода даты. При помощи атрибутов minvalue, maxvalue позволяет задавать период дат.


'''Допустимые значения:''' статичная строка
Атрибуты minvalue, maxvalue, value могут принимать значение даты в виде строки (без формулы) в формате: DD.MM.YYYY или DD.MM.YYYY HH24:MI:SS
[[Файл:Выбор даты 2.png|без|обрамить]]
'''Свойства'''
{| class="wikitable"
|'''Название атрибута'''
|'''Тип данных'''
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступен из скрипта'''
|'''Описание'''
|-
|-
| colspan="1" |Назначение
|kind
| colspan="1" |Не обязательно
|перечислимый
| colspan="1" |'''Описание:''' атрибут предназначен для описания параметра в спецификации.
|нет
|date
| colspan="1" |нет
| colspan="1" |да
|Формат даты:


'''Допустимые значения:''' статичная строка
* date - выбор даты
* datetime- выбор даты со временем
* yearmonth - выбор года и месяца (доступно в iOS)
* datetimeWithoutSeconds - выбор даты со временем без секунд
|-
| colspan="1" |minvalue
| colspan="1" |число
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |да
| colspan="1" |Минимально возможная дата доступная для выбора
|-
| colspan="1" |maxvalue
| colspan="1" |число
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |да
| colspan="1" |Максимально возможная дата для выбора
|}
|}


=== Свойства применимости ===
== Выбор времени (timeedit) ==
Компонент ввода времени в минутах. Минимальное значение - 0, максимальное значение - 999 * 60 + 59 = 59999.
[[Файл:Выбор времени 2.png|без|обрамить]]
 
== Выбор цвета ==
 
== Выпадающий список (combobox) ==
Компонент для выбора единственного значения из выпадающего списка.
[[Файл:Выпадающий список.png|без|обрамить]]
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
|'''Название атрибута'''
! colspan="1" |Наличие значения
|'''Тип данных'''
!Назначение
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
|-
| colspan="1" |Скрывать если
| colspan="1" |keytype
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.
| colspan="1" |нет
| colspan="1" |number
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Тип ключевого значения.


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
Возможные значения: "string", "number".
|-
| colspan="1" |selectedText
| colspan="1" |строка
| colspan="1" |''только для чтения''
| colspan="1" |
| colspan="1" |
| colspan="1" |да
| colspan="1" |Отображаемое текстовое значение
|-
| colspan="1" |withUserItems
| colspan="1" |булеан
| colspan="1" |нет
| colspan="1" |false
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Добавлять значения вручную. Позволяет добавлять в список значения путем ввода в поле поиска
|-
| colspan="1" |rowstyle
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" | -
| colspan="1" | -
| colspan="1" | -
| colspan="1" |Название колонки со стилями для раскрашивание элементов в списке
|-
| colspan="1" |selectedRowStyle
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" | -
| colspan="1" | -
| colspan="1" | -
| colspan="1" |Название колонки со стилями для раскрашивания активного элемента в списке
|}


* Истина - элемент скрывается на форме
== Выпадающий список с галками (checkcombobox) ==
* Ложь - элемент отображается и недоступен для редактирования значения.
Компонент для выбора множественных значений из выпадающего списка.
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
[[Файл:Выпадающий список с галками.png|без|обрамить]]
|-
'''Свойства'''
| colspan="1" |Выполнять если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
Значения выпадающего списка описываются одним из способов:


* Истина - элемент отображается и недоступен для редактирования
* вложенным тегом item, атрибуты которого key/value содержат соответственно ключ и значение списка
* Ложь - элемент отображается и недоступен для редактирования
* указанием источника данных в атрибуте source
* NULL - элемент отображается и недоступен для редактирования


''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
Задание выбранных значений осуществляется одним из способов:
|}


== Проверка ==
* Установкой атрибута selected для вложенного тега item
Проверка - это не визуальное действие, которое позволяет проверить правильность заполнения полей документа и при необходимости выдать сообщение об ошибке.
* Перечислением через запятую всех выбранных ключей в теле selected для checkcombobox


=== Основные свойства ===
{| class="wikitable"
{| class="wikitable"
!Свойство
|'''Название атрибута'''
! colspan="1" |Наличие значения
|'''Тип данных'''
!Назначение
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
| colspan="1" |selected
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |да
| colspan="1" |Перечисление через запятую выбранных ключей
|-
| colspan="1" |selectedLabels
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |
| colspan="1" |да
| colspan="1" |Перечисление через запятую с пробелом текстовых наименований выбранных ключей
|-
|-
|Параметр
| colspan="1" |sourceFillings
| colspan="1" |Обязательно
| colspan="1" |строка
|'''Описание:''' Атрибут позволяет выбрать параметр, для которого будет осуществляться проверка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |да
| colspan="1" |Строка описывающая обогащение полей курсора указанного в свойстве sourceExt. Обогащение происходит данными из курсора указанного в свойстве source.


'''Допустимые значения()''':
Запись происходит в сл. формате: Поле_1_курсор_1: Поле_1_курсор_2 ; ... ; Поле_2_Куроср_1: Поле_2_курсор_2.


* число
Здесь Поле_1_курсор_1, ..., Поле_2_Куроср_1 наименование полей курсора из свойства source, а поля Поле_1_курсор_2, ... , Поле_2_курсор_2 - поля курсора из свойства sourceExt.
* строка
* дата
* дата со временем
* логический


''Примечание: по умолчанию указано значение <Не выбран>''
Если наименования соответствующих полей совпадают, то есть Поле_1_курсор_1 = Поле_1_курсор_2, то допустпима короткая запись: Поле_1_курсор_1 ; ... ; Поле_2_Куроср_1.
|-
|}
|Тип сообщения
| colspan="1" |Обязательно
|'''Описание:''' Атрибут позволяет выбрать вид сообщения, который будет появляться в случае выполнения выражения


'''Допустимые значения''':
== Выбор из справочника  (quicksearch) ==
Компонент поиска данных.


* Ошибка - появляется сообщение красного цвета, в верху формы, если значение выражение Истина. Запрещает сохранение документа и переход в другие состояния, пока выражение Истинно
Строка поиска aka QuickSearch предназначена для быстрого и наглядного поиска и выбора пользователем требуемой записи в наборе данных. QuickSearch представляет собой строку ввода, которая используется для отображения текстового описания найденной записи и ввода подстроки для поиска по текстовому полю набора данных. QuickSearch в определенных случаях выводит на экран модальное диалоговое окно, отображающее полностью или частично набор данных и позволяющее выбрать нужную запись. Чтобы начать поиск в наборе данных пользователь вводит подстроку для поиска по текстовому полю и нажимает клавишу <Enter>. Поиск ведется независимо от регистра символов введенной подстроки. В случае, если найден только одна запись, подходящая по условию вхождения подстроки, она становится выбранной, и полное значение текстового поля набора данных отображается в строке QuickSearch. Если подходящая запись не найдена или таких записей найдено более одной, открывается диалоговое окно, отображающее набор данных отфильтрованный по заданному критерию (вхождение подстроки в значение текстового поля). В окне пользователь выбирает нужную запись или задает новый критерий поиска, вводя символы в строку ввода вверху окна. Для начала поиска записи в диалоговом окне пользователь нажимает клавишу <Enter> или кнопку "Найти".
* Предупреждение - появляется диалоговое окно(Ок/Отмена), если значение выражение Истина
[[Файл:Выбор из справочника (компонент).png|без|обрамить]]
* Информация - появляется сообщение зеленого цвета, в верху формы, если значение выражение Истина
'''Свойства'''
 
{| class="wikitable"
''По умолчанию всегда установлено значение "Ошибка"''
|'''Название атрибута'''
|'''Тип данных'''
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
| colspan="1" |onsearch
| colspan="1" |действие
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |да
| colspan="1" |Название действия (action), осуществляющее поиск по базе. Действие может быть только единичным и содержать поля поиска по идентификатору (selected) и по значению (selectedText)
|-
| colspan="1" |selectedText
searchText
| colspan="1" |строка
| colspan="1" |''только чтение''
| colspan="1" |
| colspan="1" |
| colspan="1" |
| colspan="1" |Строка поиска
|-
|-
| colspan="1" |Выражение
| colspan="1" |sourcekey
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |
| colspan="1" |'''Описание:''' Данный атрибут позволяет ввести выражение, при истинном значении которого, будет выдаваться сообщение
| colspan="1" |нет
 
| colspan="1" |нет
'''Допустимые значения''':  статичная строка
| colspan="1" |Название колонки курсора, содержащей ключевое значение, и параметра app-функции, в котором передается ключевое значение при поиске в режиме QSMODE=ID.
|-
|-
| colspan="1" |Сообщение
|sourcevalue
| colspan="1" |Обязательно
|строка
| colspan="1" |'''Описание:''' Данный атрибут позволяет задать сообщение, которое будет выдаваться в случае если выражение = Истина
|нет
|
|нет
|нет
|Название колонки курсора, содержащей значение текста, и параметра app-функции, в котором передается текстовое значение для поиска в режиме QSMODE=NAME.


'''Допустимые значения:''' статичная строка
Не рекомендуется использовать колонки со значениями атрибута displayformat равными check и icon ввиду невозможности их представления в текстовом виде в поле ввода.
|-
|-
| colspan="1" |Назначение
| colspan="1" |minChars
| colspan="1" |Не обязательно
| colspan="1" |число
| colspan="1" |'''Описание:''' атрибут предназначен для описания параметра в спецификации.
| colspan="1" |нет
 
| colspan="1" |0
'''Допустимые значения:''' статичная строка
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Наименьшее количество символов, которое требуется ввести в строке для начала поиска в базе данных.
|}
|}


=== Свойства применимости ===
== Многострочное поле (memo) ==
Компонент для ввода текстовых данных.
[[Файл:Многострочное поле.png|без|обрамить]]
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
|'''Название атрибута'''
! colspan="1" |Наличие значения
|'''Тип данных'''
!Назначение
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступен из скрипта'''
|'''Описание'''
|-
|-
| colspan="1" |Скрывать если
| colspan="1" |maxlength
| colspan="1" |Не обязательно
| colspan="1" |число
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.
| colspan="1" |нет
| colspan="1" |0
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Наибольшая возможная длина текста. Если введено число символов больше, чем заданная максимальная длина, то текст обрезается до размера, указанного в maxlength.


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
В случае отсутствия этого атрибута или его нулевого или отрицательного значения длина текста ничем не ограничена.
 
|-
* Истина - элемент скрывается на форме
| colspan="1" |immediateChange
* Ложь - элемент отображается и недоступен для редактирования значения.
| colspan="1" |булеан
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
| colspan="1" |нет
| colspan="1" |false
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Требование XM-документу реагировать на каждое изменение содержимого строки ввода и немедленно производить соответствующие расчеты.
|-
|-
| colspan="1" |Выполнять если
|lines
| colspan="1" |Не обязательно
|число
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.
|нет
|
| colspan="1" |нет
| colspan="1" |да
|Количество строк для компонента. Получается из стиля.
|}


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
== Редактирование HTML ==
Компонент для редактирования HTML-страниц.


* Истина - элемент отображается и недоступен для редактирования
Наследует все атрибуты от <текстовое поле ввода (memo)> .
* Ложь - элемент отображается и недоступен для редактирования
[[Файл:Редактирование HTML.png|без|обрамить]]
* NULL - элемент отображается и недоступен для редактирования


''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
== Галочка (Checkbox) ==
|}
Компонент для выбора, позволяющий пользователю управлять параметром с двумя состояниями — ☑ включено и ☐ выключено.
[[Файл:Галочка.png|без|обрамить]]


== Проверка данных поддокумента (CheckRows) ==
== График (chart) ==
Данное действие позволяет проверить корректность заполнения всех строк указанного поддокумента и вывести сообщение об ошибке в родительском (относительно поддокумента) окне.
Предназначен для отображения табличных данных в виде графиков. Позволяет отображать данные по условиям группировки.  
 
[[Файл:График.png|без|обрамить]]
=== Основные свойства ===
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
!Название атрибута
! colspan="1" |Наличие значения
!Тип данных
!Назначение
!Обязательность
!Значение по умолчанию
! colspan="1" |Может содержать скрипт
! colspan="1" |Доступ из скрипта
!Описание
|-
|source
|строка
|да
|
| colspan="1" |нет
| colspan="1" |да
|Курсор в котором отображаемые данные
|-
|-
|Поддокумент
| colspan="1" |kind
| colspan="1" |Обязательно
| colspan="1" |перечислимый
|'''Описание:''' Атрибут позволяет выбрать таблицу, для строк которой будут последовательно осуществляться вложенные в неё действия
| colspan="1" |нет
| colspan="1" |columnDiagram
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Определяет тип графика по умолчанию:


'''Допустимые значения''':
* columnDiagram - гистограмма
* barDiagram - панельная гистограмма
* lineDiagram - график
* areaDiagram - диаграмма участка
* pieDiagram - круговая диаграмма
|-
| colspan="1" |kindSelector
| colspan="1" |булеан
| colspan="1" |нет
| colspan="1" |true
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Определяет возможность пользователем выбирать тип графика:


* таблица
* true - есть возможность выбора
* false - нет возможности выбора
|-
| colspan="1" |yCaption
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |нет
| colspan="1" |Наименование оси Y
|-
|-
|Сообщение
| colspan="1" |legendPosition
| colspan="1" |Обязательно
| colspan="1" |перечислимый
|'''Описание:''' Атрибут позволяет задать сообщение, которое будет отображаться в случае наличия ошибки в одной из строк проверяемой таблицы
| colspan="1" |нет
| colspan="1" |bottom
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Определяет место отображения легенды графика


'''Допустимые значения''':
* top - сверху
* bottom - снизу
* left - слева
* right - справа
* none - не отображать
|-
| colspan="1" |chartColors
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Строка - список цветов разделенных запятой
|-
| colspan="1" |dataLabel
| colspan="1" |перечислимый
| colspan="1" |нет
| colspan="1" |'none'
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Отображение метки около точки (столбца, сектора) графика


* Строка
* name - отображать только имя
* Формула
* namevalue - имя и значение
 
* value - только значение
''Примечание: после указанного текста ошибки будет отображён текст ошибки, возникшей в проверяемой строке вложенной таблицы''
* none - не отображать ничего
|-
| colspan="1" |dataLabelBgColor
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Цвет фона метки
|-
| colspan="1" |dataLabelColor
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Цвет текста метки
|-
|-
| colspan="1" |Описание
| colspan="1" |dataValueFormat
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут предназначен для описания параметра в спецификации.
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Формат значения выводимого в метке
|}
'''Значение графика (value)'''


'''Допустимые значения:''' статичная строка
Характеризует величину (показатель) отображаемую в графике.
|}


=== Свойства применимости ===
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
!Название атрибута
! colspan="1" |Наличие значения
!Тип данных
!Назначение
!Обязательность
!Значение по умолчанию
!Описание
|-
|-
| colspan="1" |Скрывать если
|sourcefield
| colspan="1" |Не обязательно
|строка
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.
|да
|
|Название отображаемой колонки курсора
|-
| colspan="1" |groupSummaryKind
| colspan="1" |перечислимый
| colspan="1" |да
| colspan="1" |sum()
| colspan="1" |Определяет аналитическую функцию используемую при группировке данных:


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
* sum() - суммарное значение
 
* min() - минимальное значение
* Истина - элемент скрывается на форме
* max() - максимальное значение
* Ложь - элемент отображается и недоступен для редактирования значения.
* count() - общее количество
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
* avg() - среднее значение
|-
|-
| colspan="1" |Выполнять если
| colspan="1" |caption
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.
| colspan="1" |да
 
| colspan="1" |
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
| colspan="1" |Название величины. Будет отображаться в легенде.
 
* Истина - элемент отображается и недоступен для редактирования
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования
 
''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
|}
|}
'''Группировка графика (group)'''


== Присвоение ==
Характеризует величину (показатель) по которому выполняется группировка данных. Графически отображаются в панели "Уровни данных". Панель отображается, если количество группировок более 1.
Присвоение - действие, которое позволяет одной операцией изменить все поля документа.


=== Основные свойства ===
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
!Название атрибута
! colspan="1" |Наличие значения
!Тип данных
!Назначение
!Обязательность
!Значение по умолчанию
!Описание
|-
|sourcefield
|строка
|да
|
|Название колонки курсора по значениям которой выполняется группировка
|-
|-
| colspan="1" |Параметр
| colspan="1" |caption
| colspan="1" |Обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут предназначен для выбора параметра, для которого будет срабатывать присвоение
| colspan="1" |да
 
| colspan="1" |
'''Допустимые значения:''' любой параметр из перечисленных типов(строка, число, дата, дата со временем, логический)
| colspan="1" |Название величины. Будет отображаться в панели "Уровни данных"
|-
|-
| colspan="1" |Выражение
| colspan="1" |p-step
| colspan="1" |Обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут предназначен для задания вычислимого выражение к выбранному параметру
| colspan="1" |нет
| colspan="1" |
| colspan="1" |Шаг для отображения данных на графике (для чисел и дат )


'''Допустимые значения:''' результат выражения должен соответствовать типу параметра
Значения для дат ( 'day', 'month', 'year', 'hour' )
|-
| colspan="1" |Выполняется
| colspan="1" |Обязательно
| colspan="1" |'''Описание:''' атрибут позволяет указать каким образом будет выполняться присвоение значения (автоматически или по нажатию на кнопку)


* Автоматически - означает, что данная апп-функция будет выполняться всегда(если условия выполнения не запрещают)
Значения для чисел ( интервал в виде числа )
* По желание пользователя - в этом случае, пользователю предоставляется возможность запустить выполнение данной апп-функции с помощью кнопки, отображаемой на форме документа


''По умолчанию всегда установлено значение "Автоматически"''
Если указан шаг то данные отображаем во всем интервале, от минимального значения к максимальному, с данным шагом.
|-
|-
| colspan="1" |Описание
| colspan="1" |p-from
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
| colspan="1" |нет
 
| colspan="1" |
'''Допустимые значения:''' статичная строка
| colspan="1" |Конечное значение для интервала данных
|}


=== Свойства применимости ===
Дата ( Пример - '10.07.2014' )
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Скрывать если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
Число ( пример - '120' )


* Истина - элемент скрывается на форме
Формула (пример - '${VAR.PARAM}')
* Ложь - элемент отображается и недоступен для редактирования значения.
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
|-
|-
| colspan="1" |Выполнять если
| colspan="1" |p-to
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.
| colspan="1" |нет
| colspan="1" |
| colspan="1" |Начальное значение для интервала данных


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
Дата ( Пример - '10.02.2014' )


* Истина - элемент отображается и недоступен для редактирования
Число ( пример - '12' )
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования


''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
Формула (пример - '${VAR.PARAM}')
|}
|}


== Открытие фильтра на редактирование (editFilter) ==
== Картинка (Image) ==
Открытие фильтра на редактирование - действие, которое позволяет получить фильтр документа, открыть окно редактирования и по нажатию кнопки "Сохранить" передать фильтр документа и его описание в параметры.
[[Файл:Картинка.png|без|обрамить]]'''Свойства'''
 
=== Основные свойства ===
{| class="wikitable"
{| class="wikitable"
!Свойство
|'''Название атрибута'''
! colspan="1" |Наличие значения
|'''Тип данных'''
!Назначение
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступен из скрипта'''
|'''Описание'''
|-
|-
| colspan="1" |Параметр (param)
| colspan="1" |stretch
| colspan="1" |Необязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут предназначен для выбора параметра, для которого будет срабатывать присвоение выходного значения фильтра.
| colspan="1" |нет
| colspan="1" |<nowiki>0|false</nowiki>
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Растягивать картинку до размера визуального компонента.
Возможные значения "1"|"true" или "0"|"false" (независимы от регистра).


'''Допустимые значения:''' параметр типа строка.
Примечание: если при обращении к этому атрибуту его значение в строковом виде равно "1" или "true", то оно принимается за true, в случае любых других значений включая пустую строку или NULL оно принимается за false.
|-
| colspan="1" |iconname
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |да
| colspan="1" |Наименование иконки из репозитория для отображения на кнопке
|-
|-
| colspan="1" |Параметр описания ограничений фильтра (paramDescr)
| colspan="1" |source
| colspan="1" |Необязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут предназначен для выбора параметра, для которого будет срабатывать присвоение выходного значения описания фильтра.
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |
| colspan="1" |Указывается формула на поле датасета содержащее BLOB с изображением.  (ITMKERNEL-3917) Если заполнено source, то iconname игнорируется
|}


'''Допустимые значения:''' параметр типа строка.
== Просмотр HTML (htmlviewer) ==
Компонент для просмотра html разметки.
[[Файл:Просмотр html .png|без|обрамить]]
'''Свойства'''
{| class="wikitable"
|'''Название атрибута'''
|'''Тип данных'''
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
|-
| colspan="1" |Наименование фильтра (caption)
|value
| colspan="1" |Необязательно
|любой тип
| colspan="1" |'''Описание:''' атрибут позволяет задать заголовок (наименование) окна редактора фильтра.
|нет
|пусто
| colspan="1" |да
| colspan="1" |да
|Значение поля ввода
|}


'''Допустимые значения''': формула, результат - строка или STRING_NULL.
== Сравнение текстов (comparison) ==
Предназначен для визуального сравнения двух передаваемых текстов.
[[Файл:Сравнение текстов.png|без|обрамить]]
'''Свойства'''
{| class="wikitable"
!Название атрибута
!Тип данных
!Обязательность
!Значение по умолчанию
! colspan="1" |Может содержать скрипт
! colspan="1" |Доступ из скрипта
!Описание
|-
| colspan="1" |showAll
| colspan="1" |булеан
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Отображать текст полностью
|-
| colspan="1" |rightSide
| colspan="1" |строка
| colspan="1" |да
| colspan="1" |
| colspan="1" |да
| colspan="1" |да
| colspan="1" |Текст правой стороны
|-
|-
| colspan="1" |Тип юниверса (universeType)
|leftSide
| colspan="1" |Обязательно
|строка
| colspan="1" |'''Описание:''' Атрибут предназначен для выбора типа.
|да
|
| colspan="1" |да
| colspan="1" |да
|Текст левой стороны
|}


'''Допустимые значения:'''
== Карта (mapView) ==
Отображает интерактивную карту с возможностью размещать на ней точки, линии (в том числе состоящие из множества отрезков) и многоугольники.


* ETRAN - BO юниверс
Для размещённых объектов доступна настройка внешнего вида и обработчиков событий перетаскивания и нажатия.
* DOCUNV - XM юниверс
[[Файл:Карта.png|без|обрамить]]
 
'''Свойства'''
''По умолчанию задано значение DOCUNV''
{| class="wikitable"
|'''Название атрибута'''
|'''Тип данных'''
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
|source
|строка
|да
|
| colspan="1" |нет
| colspan="1" |нет
|Источник данных (датасет) для отображения объектов на карте
|-
| colspan="1" |fit
| colspan="1" |булеан
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Автоматически изменять позицию и масштаб карты для оптимального отображения всех объектов. При установке атрибута fit=true атрибуты latitude, longitude и zoom игнорируются.
|-
| colspan="1" |latitude
| colspan="1" |число
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Начальное положение центра карты по широте. Атрибут игнорируется, если fit=true.
|-
|-
| colspan="1" |ИД юниверса (universeId)
| colspan="1" |longitude
| colspan="1" |Обязательно
| colspan="1" |число
| colspan="1" |'''Описание:''' Атрибут позволяет ввести ИД юниверса (для типа ETRAN )
| colspan="1" |нет
 
| colspan="1" |
'''Допустимые значения:''' статичное число
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Начальное положение центра карты по долготе. Атрибут игнорируется, если fit=true.
|-
|-
| colspan="1" |Ключевое слово (bo_unitype)
| colspan="1" |zoom
| colspan="1" |Обязательно
| colspan="1" |число
| colspan="1" |'''Описание:''' атрибут позволяет задать ключевое слово дополнительно к ИД юниверса
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Начальное значение масштаба карты. Атрибут игнорируется, если fit=true.


'''Допустимые значения''': формула, результат - строка или STRING_NULL.
Принимаемые значения: целые и дробные числа от 0 (мир) до 23 (улица/дом).
|-
|-
| colspan="1" |Тип документа (docTypeId)
| colspan="1" |allowMove
| colspan="1" |Обязательно
| colspan="1" |булеан
| colspan="1" |'''Описание:''' Атрибут позволяет выбрать тип документа (для типа DOCUNV)
| colspan="1" |нет
 
| colspan="1" |
'''Допустимые значения:''' статичное число
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Разрешать ли пользователю перемещение по карте
|-
|-
| colspan="1" |Описание (description)
| colspan="1" |allowZoom
| colspan="1" |Обязательно
| colspan="1" |булеан
| colspan="1" |'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
| colspan="1" |нет
 
| colspan="1" |
'''Допустимые значения:''' статичная строка
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Разрешать ли пользователю изменять масштаб карты
|-
|-
| colspan="1" |Режим редактирования фильтра (editmode)
| colspan="1" |dragAction
| colspan="1" |Необязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' Задает режим редактирования фильтра (что можем менять)
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Название действия, запускаемого сразу после перетаскивания пользователем объекта на карте.


'''Допустимые значения:'''
Доступ к свойствам перемещённого объекта осуществляется через обращение к свойствам <имя компонента карты>.selectedObject.<id|name|object_class|latitude|longitude>.


* full - Полное (поля, группировка и ограничения)
Если не указано, перетаскивание объектов на карте недоступно.
* where - Только ограничения
|-
 
| colspan="1" |selectedObject.id
''По умолчанию задано значение where''
| colspan="1" |целое число
| colspan="1" |''только чтение''
| colspan="1" |
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Идентификатор объекта
|-
| colspan="1" |selectedObject.name
| colspan="1" |строка
| colspan="1" |''только чтение''
| colspan="1" |
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Отображаемое наименование объекта
|-
| colspan="1" |selectedObject.object_class
| colspan="1" |строка
| colspan="1" |''только чтение''
| colspan="1" |
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Тип объекта — point, line или polygon
|-
|-
| colspan="1" |Список полей (selstr)
| colspan="1" |selectedObject.latitude
| colspan="1" |Необязательно
| colspan="1" |число
| colspan="1" |'''Описание:''' атрибут предназначен для выбора параметра, для которого будет срабатывать для получения входного и присвоение выходного значения полей фильтра (для типа ETRAN ).
| colspan="1" |''только чтение''
 
| colspan="1" |
'''Допустимые значения:''' параметр типа строка.
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Координаты (широта)
|-
|-
| colspan="1" |Список полей группировки (groupstr)
| colspan="1" |selectedObject.longitude
| colspan="1" |Необязательно
| colspan="1" |число
| colspan="1" |'''Описание:''' атрибут предназначен для выбора параметра, для которого будет срабатывать для получения входного и присвоение выходного значения полей группировки фильтра (для типа ETRAN ).
| colspan="1" |''только чтение''
 
| colspan="1" |
'''Допустимые значения:''' параметр типа строка.
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Координаты (долгота)
|}
|}
'''Описание формата датасета'''


=== Свойства применимости ===
Для работы компонента используемый датасет должен иметь соответствующий формат:
{| class="wikitable"
{| class="wikitable"
!Свойство
|'''Название атрибута строки датасета'''
! colspan="1" |Наличие значения
| colspan="1" |'''Тип данных'''
!Назначение
|'''Описание'''
| colspan="1" |'''Пример'''
|-
|ID
| colspan="1" |целое число
|Идентификатор объекта
| colspan="1" |
|-
|-
| colspan="1" |Скрывать если
|OBJECT_CLASS
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.
|Тип объекта:


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
* point — точка
* line — отрезок
* polygon — многоугольник
| colspan="1" |
|-
| colspan="1" |ACTIONCLASS
| colspan="1" |строка
| colspan="1" |Название действия, выполняемое при нажатии на объект
| colspan="1" |
|-
| colspan="1" |NAME
| colspan="1" |строка
| colspan="1" |Отображаемое наименование объекта
| colspan="1" |
|-
| colspan="1" |POINTS
| colspan="1" |строка
| colspan="1" |Координаты объекта.
 
Двумерный массив, содержащий массив(ы) пар координат (долгота, широта).
| colspan="1" |
* Точка: <nowiki>[[87.18613, 53.99818]]</nowiki>
* Прямая линия (2 точки):  [[87.18613,53.99818], [87.18613,53.99818]]
* Ломаная линия (от 3 точек): [[87.18613,53.99818], [87.18613,53.99818], [87.19036,53.99834], [87.19947,53.99891]]
* Многоугольник (если начальная и конечная точки не совпадают, они будут автоматически соединены ещё одним отрезком): [[87.7959426611866, 49.26152638335681], [98.9204449286504, 52.05763105135641], [116.44619710420787, 49.98618250048632], [113.77383063772218, 44.77401901529287], [96.4345226342451, 42.7089399393454], [89.59823632463048, 47.821523331564144]]


* Истина - элемент скрывается на форме
* Ложь - элемент отображается и недоступен для редактирования значения.
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
|-
|-
| colspan="1" |Выполнять если
| colspan="1" |STYLE
| colspan="1" |Не обязательно
| colspan="1" |строка (JSON)
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.
| colspan="1" |JSON, содержащий набор свойств, описывающих внешний вид объекта. Содержимое зависит от типа объекта — некоторые свойства у точек, отрезков и полигонов различаются, некоторые совпадают.


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
* captionVisibilityLevel (число 0/1/2) Видимость отображаемого наименования объекта. 0 — не отображать, 1 — отображать при наведении мыши, 2 — отображать всегда. Применимо к точкам и полигонам.
* color (цвет в hex-формате в строковом представлении) Для point и polygon — цвет границы (border) Для line — цвет отрезка
* backgroundColor (такой же формат, как у color) Цвет заливки
* opacity (дробное число в диапазоне с 0 по 1) Прозрачность объекта
* iconUrl (строка) Относительный или абсолютный url до файла изображения, которое будет использовано в качестве иконки маркера точки или размещено в центре полигона.
* thickness (целое число) Толщина отрезка в пикселах


* Истина - элемент отображается и недоступен для редактирования
Итого, использование свойств по типам объектов:
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования


''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
* point:
** captionVisibilityLevel
** color
** backgroundColor
** opacity
** iconUrl
* line:
** color
** thickness
** opacity
* polygon:
** captionVisibilityLevel
** color
** backgroundColor
** opacity
** iconUrl
| colspan="1" |
* Точка со всегда отображаемым наименованием, заданными цветами фона, обводки, частичной прозрачностью и иконкой: {"captionVisibilityLevel": 2, "color": "#1c0f80", "backgroundColor": "#fdf877", "opacity":0.75, "iconUrl":"<nowiki>http://10.144.18.109:8083/extra-media/char1.png</nowiki>"}
*
|}
|}


== Внешнее действие ==
== Дерево группировки грида (gridGroupingTree) ==
Внешнее действие - это действие позволяющее открыть другой документ/режим/печатную форму.
Компонент для отображения группировки грида в виде отдельного дерева.
 
[[Файл:Дерево группировки грида.png|без|обрамить]]
=== Основные свойства ===
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
|'''Название атрибута'''
! colspan="1" |Наличие значения
|'''Тип данных'''
!Назначение
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
|-
|Тип
| colspan="1" |
| colspan="1" |Обязательно
gridname
|'''Описание:''' атрибут предназначен для выбора одного из 4х возможных внешних действии.
| colspan="1" |строка
 
| colspan="1" |нет
'''Допустимые значения''':
| colspan="1" |
 
| colspan="1" |нет
* Печатная форма
| colspan="1" |нет
* Создать документ
| colspan="1" |Имя грида, к которому привязано дерево в формате Window.gridName
* Открыть документ
* Открыть режим
 
''По умолчанию тип не выбран''
|-
|-
| colspan="1" |Описание
| colspan="1" |groupby
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
| colspan="1" |нет
 
| colspan="1" |
'''Допустимые значения:''' статичная строка
| colspan="1" |да
| colspan="1" |нет
| colspan="1" |Колонки для группировки. Cписок имен колонок по которым будет сформировано дерево фильтра, через запятую
|-
|-
| colspan="1" |Назначение
| colspan="1" |showExpandCollapseButtons
| colspan="1" |Не обязательно
| colspan="1" |логический
| colspan="1" |'''Описание:''' атрибут предназначен для описания параметра в спецификации.
| colspan="1" |нет
 
| colspan="1" |false
'''Допустимые значения:''' статичная строка
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Кнопки свернуть всё / развернуть всё
|}
|}


=== Основные свойства для Печатной формы ===
== Дерево ==
Компонент для отображения данных датасета в виде дерева.
[[Файл:Дерево.png|без|обрамить]]
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
|'''Название атрибута'''
! colspan="1" |Наличие значения
|'''Тип данных'''
!Назначение
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
| colspan="1" |sourceparent
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Колонка, содержащая id родительского узла
|-
|-
| colspan="1" |Формат данных
| colspan="1" |onrowselect
| colspan="1" |Обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' Атрибут предназначен для выбора формата данных.
| colspan="1" |нет
| colspan="1" |
| colspan="1" |да
| colspan="1" |нет
| colspan="1" |Действие при выборе строки
|-
| colspan="1" |sourceicon
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Колонка с иконкой. Имя колонки грида с id иконок
|-
| colspan="1" |sourceloadondemand
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Колонка для подзагрузки. Имя колонки, содержащей флаг необходимости подгрузить строки
 
Допустимые значения в датасете:


'''Допустимые значения:'''
0 - без подзагрузки


* XLS - позволяет сохранять печатную форму в формате XLS
1 - Полная загрузка
* PDF - позволяет сохранять печатную форму в формате PDF


''По умолчанию задано значение XLS''
2 - Загрузка с фильтрацией (пользователю показывается окно с текстовым вводом)
|-
|-
| colspan="1" |Идентификатор отчета
| colspan="1" |onsearch
| colspan="1" |Обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' Атрибут позволяет ввести идентификатор шаблона, который будет открываться(сохраняться) при нажатии на кнопку
| colspan="1" |нет
| colspan="1" |
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Действие для подзагрузки (единичное действие, возвращающее датасет)


'''Допустимые значения:''' статичная строка
К параметрам заданным в дизайнере будет добавлено еще 2
 
ID - содержит id ноды, для которой загружаем данные
 
TEXT - текст введенный пользователем для фильтрации
|-
| colspan="1" |showExpandCollapseButtons
| colspan="1" |логический
| colspan="1" |нет
| colspan="1" |false
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Кнопки свернуть всё / развернуть всё
|}
|}
'''Cтрока поиска (searchBox)'''
Даёт возможность поиска по тексту, отображаемому в дереве


=== Свойства для Создания документа ===
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
!Название атрибута
! colspan="1" |Наличие значения
!Тип данных
!Назначение
!Обязательность
!Значение по умолчанию
!Описание
|-
|caseSensitive
|булеан
|нет
|false
|Регистрозависимый поиск
|-
| colspan="1" |showCaseSensitiveButton
| colspan="1" |булеан
| colspan="1" |нет
| colspan="1" |false
| colspan="1" |Отображать кнопку регистрозависимого поиска
|-
| colspan="1" |useRegexp
| colspan="1" |булеан
| colspan="1" |нет
| colspan="1" |false
| colspan="1" |Использовать регулярное выражение
|-
| colspan="1" |showUseRegexpButton
| colspan="1" |булеан
| colspan="1" |нет
| colspan="1" |false
| colspan="1" |Отображать кнопку для регулярного выражения
|-
|-
| colspan="1" |Тип документа
| colspan="1" |showClearSearchFieldButton
| colspan="1" |Обязательно
| colspan="1" |булеан
| colspan="1" |'''Описание:''' Атрибут позволяет выбрать тип документа
| colspan="1" |нет
| colspan="1" |true
| colspan="1" |Отображать кнопку очистки строки поиска
|}
 
== Диаграмма Ганта ==
Предназначен для отображения специализированных данных (план, график, расписание, управление проектами) в виде диаграммы Ганта, являющейся подвидом столбчатых диаграмм (гистограмм).


'''Допустимые значения:''' статичная строка
Для работы необходимо предоставить компоненту два специально подготовленных набора данных (датасета). Первый формирует табличную часть (слева), второй — диаграмму (справа).
|-
[[Файл:Диаграмма Ганта.png|без|обрамить]]
| colspan="1" |Апп-функция получения экземпляра документа
Свойства таблицы и графика задаются в дочерних тегах:
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' Атрибут позволяет выбрать апп-функция, в которой будет передаваться экземпляр для документа данного типа


'''Допустимые значения:''' статичная строка
'''1. График диаграммы (chart)'''
|-
| colspan="1" |Дополнительно/Скрыть
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' Атрибут позволяет указать название режима


'''Допустимые значения:''' статичная строка
Настраивает отображение графика в диаграмме Ганта
|}


=== Свойства для Открытия документа ===
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
!Название атрибута
! colspan="1" |Наличие значения
!Тип данных
!Назначение
!Обязательность
! colspan="1" |Может содержать скрипт
!Значение по умолчанию
!Описание
|-
|source
|строка
|да
| colspan="1" |
|
|Название курсора из action, содержащей данные для отображения на диаграмме
|-
|-
|Идентификатор документа
| colspan="1" |fk
| colspan="1" |Обязательно
| colspan="1" |строка
|'''Описание:''' атрибут предназначен для указания выражения, которое будет содержать идентификатор открываемого документа
| colspan="1" |да
| colspan="1" |
| colspan="1" |
| colspan="1" |Название колонки курсора, содержащее первичный ключ


'''Допустимые значения''': статичная строка
Тип данных колонки должен быть число
|-
| colspan="1" |timeStart
| colspan="1" |строка
| colspan="1" |да
| colspan="1" |
| colspan="1" |
| colspan="1" |Начальная позиция отрезка, размещаемого на временной диаграмме


''По умолчанию тип не выбран''
Тип данных колонки должен быть дата
|-
|-
| colspan="1" |Название режима
| colspan="1" |timeEnd
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |Атрибут позволяет указать название режима
| colspan="1" |да
|}
| colspan="1" |
| colspan="1" |
| colspan="1" |Конечная позиция отрезка


=== Свойства для Открытия режима ===
Тип данных колонки должен быть дата
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|-
|Идентификатор
| colspan="1" |label
| colspan="1" |Обязательно
| colspan="1" |строка
|'''Описание:''' атрибут предназначен для указания выражения, которое будет содержать идентификатор режима
| colspan="1" |да
| colspan="1" |
| colspan="1" |
| colspan="1" |Текст, отображаемый на элементе диаграммы


'''Допустимые значения''': статичная строка(Значение может задаваться явно, т.е. в числовом виде, либо через переменную документа. например XM_DOCUMENT.num, где XM_DOCUMENT - название документа, num - имя переменной )
Тип данных колонки должен быть строка
 
''По умолчанию тип не выбран''
|-
|-
| colspan="1" |Название режима
| colspan="1" |zoom
| colspan="1" |Не обязательно
| colspan="1" |число
| colspan="1" |Атрибут позволяет выбрать название из существующих режимов
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |15
| colspan="1" |Масштаб отображения диаграммы. Число с плавающей точкой в диапазоне с 10 (максимально подробный масштаб) по 22 (самый сжатый вид).
|}
|}
'''2. Таблица диаграммы (table)'''
Используется для настройки табличной части диаграммы Ганта. Содержит вложенные теги для описания колонок таблицы.


=== Свойства применимости ===
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
!Название атрибута
! colspan="1" |Наличие значения
!Тип данных
!Назначение
!Обязательность
!Значение по умолчанию
!Описание
|-
|-
| colspan="1" |Скрывать если
|source
| colspan="1" |Не обязательно
|строка
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.
|да
 
|
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
|Название курсора из action, содержащей данные для отображения в таблице
 
* Истина - элемент скрывается на форме
* Ложь - элемент отображается и недоступен для редактирования значения.
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
|-
|-
| colspan="1" |Выполнять если
| colspan="1" |id
| colspan="1" |Не обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.
| colspan="1" |да
 
| colspan="1" |
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
| colspan="1" |Название колонки курсора, содержащее первичный ключ
 
* Истина - элемент отображается и недоступен для редактирования
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования


''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
Тип данных колонки должен быть число
|}
|}

Текущая версия на 05:25, 28 июля 2022

Окно (window)

Родительский элемент для всех визуальных элементов. Соответствует окну в терминах операционной системы.

Окно.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
caption строка да да да Заголовок окна
resize строка нет 1|true нет да Допускает ли окно возможность изменения его размеров пользователем. Доступно начиная с XBF_3 и XMModule_3.0.xsd. Возможные значения "1"|"true" или "0"|"false" (независимы от регистра).

Примечание: если при обращении к этому атрибуту его значение в строковом виде равно "1" или "true", то оно принимается за true, в случае любых других значений включая пустую строку или NULL оно принимается за false.

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

Контейнер объектов (container)

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

Контейнер объектов 1.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
direction перечислимый нет vertical нет да Определяет способ расположения дочерний элементов
  • vertical - элементы располагаются по вертикали
  • horizontal - элементы располагаются по горизонтали
cssstylecontent строка нет нет да CSS Стиль блока с содержимым для контейнера
ratio число нет 1 нет нет Определяет пропорции ширины или высоты для контейнера
readonly строка нет 0|false да да Значение данного свойства обратно значению свойства enabled. Присвоение значения свойству readonly не имеет действия. Возможные значения "1"|"true" или "0"|"false" (независимы от регистра).

Примечание: если при обращении к этому атрибуту его значение в строковом виде равно "1" или "true", то оно принимается за true, в случае любых других значений включая пустую строку или NULL оно принимается за false.

Вкладки (tabsheet)

Вкладка — это визуальный элемент, который позволяет создавать множество вкладок, для размещения на них визуальных элементов.

Вкладка 2.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
activeTabCaption строка только для чтения нет да Название активной вкладки. Если ни одна из вкладок не активна, то значение атрибута равно пустой строке.
activeTabPosition число только для чтения нет да Позиция активной вкладки. Нумерация вкладок начинается с единицы. Если ни одна из вкладок не активна, то значение атрибута равно нулю.
activeTab строка да да Название активной вкладки. Если название задано, при загрузке режима вкладка с этим названием становится активной
direction строка horizontal нет да Направление отображения вкладок (vertical - вкладки слева, контент - справа | horizontal - вкладки сверху, контент снизу)
cssstylecaption строка нет да Имя CSS стиля вкладки
cssstyleactive строка нет да Имя CSS стиля активной вкладки
enableCollapse булеан false нет да Возможность сворачивания (только для вкладок с направлением отображения "vertical")
collapsed число 0 нет да Положение по умолчанию (свернуты - 1, развернуты - 0)

Панель кнопок (toolbar)

Панель кнопок - визуальный элемент, который позволяет разместить в себе группу кнопок.

Панель кнопок 2.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
readonly строка 0|false да да Значение данного свойства обратно значению свойства enabled. Присвоение значения свойству readonly не имеет действия. Возможные значения "1"|"true" или "0"|"false" (независимы от регистра).

Кнопка (button)

Позволяет добавить на панель кнопку, которую в последствие можно привязать к какому-либо действию, созданному в правилах заполнения (к примеру Апп-функция).

Кнопка 2.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступен из скрипта Описание
onclick действие нет нет да Название действия (action/actiongroup), выполняемое при нажатии на кнопку
iconname строка нет да да Наименование иконки из репозитория для отображения на кнопке
hint строка нет да да Текст всплывающей подсказки при наведении на кнопку

Текст/подпись (label)

Подпись.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступен из скрипта Описание
onclick действие нет нет нет Название действия (action/actiongroup), выполняемое при клике на тексте

Таблица (grid)

Компонент для отображения табличных данных.

Таблица 2.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
groupby строка нет да нет Перечисление колонок курсора для их группировки через запятую (Только для Delphi)
groupbox булеан нет true нет нет При истинном значении отображается поле для ручной группировки данных пользователем (Только для Delphi)
selectedRow строка курсора только чтение нет да Позволяет получить данные из выделенной в гриде строке, дополнительно указав название колонки в курсоре. Например выражение:
${window.grid.selectedRow.rw_name}

возвращает из выделенной строки грида grid значение ячейки в колонке с именем rw_name

selectedRows строка курсора только чтение нет да Позволяет получить данные из выделенных в гриде строк, дополнительно указав название колонки в курсоре. Например выражение:
${window.grid.selectedRows.rw_name}

возвращает через запятую из выделенных строк грида значение ячеек в колонке с именем rw_name. В случае, когда выделена только одна строка в гриде, атрибут работает как selectedRow

selectedCell любой тип только чтение нет да Позволяет получить данные из выделенной ячейки грида. Например выражение:
${window.grid.selectedCell}

возвращает значение выделенной ячейки грида

selectedSourceField строка только чтение нет да Название колонки в курсоре данных, соответствующей выделенной колонки грида
${window.grid.selectedSourceField}
selectedGroup строка только чтение нет да Информация о группировке. Формат:
<group>

   

   <col_name>group_value</col_name>

</group>

Например, если данные в гриде сгруппированы по колонка A и B. Осуществляется попытка провалиться в итоги, где A="Значение A", B="Значение B", то результирующая строка будет

<group>

   <A>Значение A</A>

   <B>Значение B</B>

</group>

Не поддерживается в XM

selectioncolumn строка только чтение нет нет Имя колонки (поля), в котором пользователь сможет осуществлять выделение галочкой.

!!! поле с таким именем должно присутствовать в датасете, а колонка с этим полем - в списке колонок грида!!!

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

Если этот атрибут равен "true", то значение атрибута numerate игнорируется и считается равным "false".

columnfiltereditemslist булеан нет false нет нет При фильтрации в фильтрах колонок грида присутствуют только значения видимые в результате применения фильтров по другим колонкам(иначе фильтры колонок содержат все значения).
groupHeaderLineCount число нет 1 нет нет Количество строк в заголовке группы.
cansort булеан нет true нет нет Дать возможность пользователю сортировать данные.
expandGroups булеан нет false нет нет Развернуть группировки.
checkedRows строка курсора только чтение нет да Позволяет получить данные из строк в гриде, отмеченными галочками, дополнительно указав колонку название колонки в курсоре. Значения будут перечислены через запятую.

Например выражение:

${window.grid.checkedRows.rw_id}

для отмеченных строк грида rw_id = 10 и rw_id=20 вернет "10,20"

Отмеченной строкой грида является та строка, у которой значение колонки из selectioncolumn равно истине

rowstyle строка нет нет да "Стиль строки" - Название колонки, содержащей информацию о раскраске строки таблицы. Формат раскраски описан в статье (Выделение цветом строк в окне фильтра) - TTTTTT$BBBBBB$SSSS
selectedRowStyle строка нет нет да "Стиль выделенной строки" - Название колонки, содержащей информацию о раскраске выделенной строки таблицы. Формат раскраски описан в статье (Выделение цветом строк в окне фильтра) - TTTTTT$BBBBBB$SSSS
minRows число нет нет нет Минимальное число строк на странице
maxRows число нет нет нет Максимальное число строк на странице
selectedColumnName строка только чтение нет да Название активной колонки (которое отображается в шапке грида)
selectedColumnNameWithBands строка только чтение нет да Для сложных шапок - последовательность названий колонок, в которые входит активная, начиная сверху, через запятую.

Пример: Верхний бенд, средний бенд, название колонки.

selectedColumnBand(xx) строка только чтение нет да Возвращает функцию для расчета сложных шапок - названий бендов. Для получения последовательности бендов заданного уровня, необходима запись типа ${eval(windowName.gridName.selectedColumnBand,xx)}, где windowName - имя формы, gridName - имя грида, xx - номер уровня (считается от колонки вверх).
exportCaption строка нет да нет Текст в шапке листа Excel при экспорте.

Обработчики событий

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
ondrilldown действие (action/actiongroup) нет да нет Название действия, выполняемое при двойном щелчке на строк. Если столбцу грида, в ячейке которого был выполнен двойной щелчток мышью также содержит атрибут ondrilldown, то выполняется действие, назначенное столбцу.
onrowselect действие (action/actiongroup) нет да нет Название действия, выполняемое при смене активной строки грида.

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

onrowclick действие (action/actiongroup) нет да нет Название действия, выполняемое при нажатии на строку грида.

Группа колонок грида (colgroup)

Объединяет несколько подряд идущих колонок в одну визуальную группу.

Группа колонок 2.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
caption строка да да нет Название группы колонок

Колонка (column)

Описывает визуальное представление колонки грида и связывает колонку с курсором данных.

Колонка 2.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
caption строка да да нет Название колонки
sourcefield строка да нет нет Название отображаемой колонки курсора
displayformat перечислимый нет нет Формат отображения данных:
  • currency - отображение денег
  • number - отображение произвольного числа
  • date - дата
  • datetime -дата со временем
  • check - булеан в виде checkbox
  • string - строка (в разработке)
  • icon - иконка по идентификатору
  • checkicon - кликабельная иконка - при клике на нее значение поля меняется на +1 и иконка меняется на следующую из списка icons (если список исчерпан, то с начала списка и значение поля равно 0)
summary строка нет нет Формула для расчета итогов и подытогов колонки. Формулы 1-го рода - агрегирующие функции:
  • sum() - просуммировать значения текущей колонки. Применяется для типов данных: число (деньги)
  • min() - минимальное значение текущей колонки. Применяется для типов данных: число (деньги), дата
  • max() - максимальное значение текущей колонки. Применяется для типов данных: число (деньги), дата
  • avg() - среднее значение значений текущей колонки. Применяется для типов данных: число (деньги)
  • count() - количество строк в текущей колонке. Применяется для всех типов данных
  • countdistinct() - количество строк с уникальными значениями в текущей колонке. Применяется для всех типов данных
  • countnotempty() - количество строк с не пустыми значениями в текущей колонке. Применяется для всех типов данных

Формулы 2-го рода - агрегирующие функции по произвольным колонкам курсора:

  • sum(название колонки курсора) - просуммировать значения заданной колонки (суммирует значения только из заданных в гриде колонок)
  • min(название колонки курсора) - минимальное значение заданной колонки
  • max(название колонки курсора) - максимальное значение заданной колонки
  • avg(название колонки курсора) - среднее значение значений заданной колонки
  • count(название колонки курсора) - количество строк в заданной колонке
  • countdistinct(название колонки курсора) - количество строк с уникальными значениями в заданной колонке
  • countnotempty() - количество строк с не пустыми значениями в текущей колонке. Применяется для всех типов данных
  • group(название колонки курсора) - используется для условия подсчёта подытогов. Подытог рассчитывается только для данных, группируемых по колонке, указанной в group.

Формулы 3-го рода - формулы первого и второго рода и операторы для $-выражений. Например:

sum(название колонки курсора) + min() - сумма значений заданной колонки плюс минимальное значение в текущей колонке.

XM-формула

Есть возможность так же использовать xm-формулы, они обязательно должны быть обернуть в $ выражение - ${Текст формулы}

summaryformat строка нет нет Формат отображения данных итогов и подытогов колонки:
  • currency - отображение денег
  • number - отображение произвольного числа

Примечание: если в summary колонки находится формула 2-го или 3-го рода (см. summary), то необходимо определить формат итога

для значения формулы с помощью summaryformat.

headerstyle стиль да нет Стиль шапки колонки. Фактически используется только для задания ширины колонки.
contentstyle стиль да нет Стиль данных по колонке. Никак не влияет на внешний вид колонки. Добавлен на случай будущего расширения стилей дополнительными атрибутами.
descriptionfunc строка нет нет Наименование апп-функции, для получения описания картинки
visible строка нет 1|true да нет Видимость столбца. Возможные значения "1"|"true" или "0"|"false" (независимы от регистра).

Примечание: если при обращении к этому атрибуту его значение в строковом виде равно "1" или "true", то оно принимается за true, в случае любых других значений включая пустую строку или NULL оно принимается за false.

widthinchars число нет нет нет Начальная ширина колонки в размере равном указанному количеству латинских символов "a"
icons строка нет нет нет Список идентификаторов системных иконок которые последовательно будут отображаться в поле типа checkicon при изменении значения поля. (Первая иконка списка отображается при значении поля 0, вторая 1 итд)
cellstyle строка нет нет нет нет Название колонки, содержащей информацию о раскраске ячейки в колонке таблицы.

Значением в поле колонки стиля должна быть строка, содержащая json с настройками стилизации ячейки в строке.

Поддерживаются следующие параметры стилизации:

bgcolor - цвет заливки ячейки

textcolor - цвет текста ячейки

textalign - кастомное выравнивание содержимого ячейки по горизонтали (  left, center, right )

fractionDigits - количество знаков после запятой для ячеек с типом "number" - (параметр числовой - то есть "fractionDigits": 2 , а не "2")

bold (true/false) - жирный шрифт

italic (true/false) - курсив

underline (true/false) - подчеркивание

strikethrough (true/false) - перечеркивание

Например '{"bgcolor": "#00ff00", "textcolor": "#ffff00", "underline": true, "strikethrough": false}'

Важно, чтобы значением свойств bold, italic, underline и strikethrough было именно булево значение true или false, а не строки "true" или "false"

headerLineBreak булеан false нет нет Признак переноса строки в заголовке колонки.
headerTextAlign строка left нет нет Выравнивание текста в заголовке колонки:
  • left - по левому краю;
  • center - по центру;
  • right - по правому краю;
  • justify - по ширине.
withDischarges булеан нет false нет нет Разделение на разряды. Учитывается для колонок с форматом отображения число или деньги.

Обработчики событий

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
ondrilldown действие (action/actiongroup) да нет Название действия при проваливании в ячейку. Информацию о ячейке можно получить из атрибутов selectedCell, selectedSourceField, selectedRow
ondrillsummary действие (action/actiongroup) да нет Название действия при проваливании в строку итогов. Информацию о группировки можно получить из атрибута selectedGroup
onchangevalue действие (action/actiongroup) да нет Для displayformat "check" и "checkicon" - определяет действие которое будет вызываться при смене значения в ячейке (клике на чекбокс/иконку).

Вызывается после установки нового значения в гриде.

Форматирование данных

Тип данных/displayformat Выравнивание Способ форматирования
Число/number справа
  • В целой части используются разделители тысячных в виде пробелов
  • Дробная часть отображается только при ее наличии, т.е. она не равна 0
  • Дробная часть может иметь длину не более 6 знаков
  • Если дробная часть имеет больше 6 знаков, она округляется по правилам математики
  • Дробная часть не должная содержать в качестве последних символов нули
Дата/date по центру Формат отображения: dd.mm.yyyy hh24:mi:ss.

Время отображается только, если оно не равно 00:00:00

/datetime по центру Формат отображения: dd.mm.yyyy hh24:mi:ss
/currency справа
  • В целой части используются разделители тысячных в виде пробелов
  • Дробная часть всегда отображается и имеет два знача после запятой. Например, для целый чисел дробная часть равна "00"
Строка/string (в разработке) слева Данные, отличные от строки, форматируются в строку согласно правилам "Способ форматирования" для каждого типа данных. Исключение для чисел, при форматировании в строку для них не используются разделители тысячных

Числовое поле (numedit)

Компонент для ввода числовых данных.

Числовое поле 2.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
displayformat перечислимый нет number нет нет Формат отображения данных:
  • currency - отображение денег
  • number - отображение произвольного числа
totalDigits число нет нет нет Допустимая длина числа

Мин. - 1 (oracle), макс. - 38 (oracle)

Если значение не задано, оно считается равным максимальному

fractionDigits число нет нет нет Допустимая длина дробной части

Мин. - 1 (oracle), макс. - 10 (oracle)

Если значение не задано, оно считается равным максимальному

withDischarges булеан нет true нет нет Разделить число на разряды
incDecButtonsNeeded булеан нет false нет нет Управляет отображением кнопок увеличения\уменьшения значения на 1.

Текстовое поле ввода (edit)

Компонент для ввода текстовых данных.

Текстовое поле 2.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
password булеан нет false нет да При истинном значении текст отображается в зашифрованном виде
maxlength число нет 0 нет да Наибольшая возможная длина текста. Если введено число символов больше, чем заданная максимальная длина, то текст обрезается до размера, указанного в maxlength.

В случае отсутствия этого атрибута или его нулевого или отрицательного значения длина текста ничем не ограничена.

immediateChange булеан нет false нет нет Требование XM-документу реагировать на каждое изменение соджержимого строки ввода и немедленно производить соответствующие расчеты.
mask строка нет нет нет Маска ввода. Содержит шаблон, по которому будет форматировано значение поля.

Шаблоны бывают двух видов - маска и обычное регулярное выражение.

1) Шаблон типа "Маска":

0 - любое число

a (латинская) - любая буква

* - любой символ

[] - все, что внутри, к вводу необязательно

{} -все, что внутри, останется в value у поля. Используется для тех символов, которые уже являются частью маски изначально - например, знаки пунктуации. Так, данные, введенные по маске 000-000 не будут в итоге содержать дефиса (он будет добавляться только в саму маску поля, без передачи в БД\хранилище при сохранении), а по 000{-}000 - будут.

Если какой-то из вышеперечисленных символов нужно вставить буквально, его надо экранировать обратным слешем - \ (то есть \0 позволит только ноль вставить).


Также существует возможность вставить в шаблон типа "Маска" регулярное выражение с квантификатором. Само регулярное выражение должно записываться в круглых скобках, например:

([A-Z])

Такая запись будет соответствовать одному символу. Если символов несколько, то добавляется квантификатор в круглых скобках, следующих за скобками с RegExp:

([A-Z])(4) - нужно ввести строго 4 символа.

([A-Z])(1,4) - минимум один, максимум 4.

Квантификатор не может быть открытый, т.к. шаблон типа "Маска" подразумевает точное указание количества символов.

Если необходимо сделать круглую скобку частью маски, то ее нужно экранировать обратным слешем - \. Пример:

\(([A-Z])(1, 4)\) - ввод пользователя будет обрамлен круглыми скобками.

2) Шаблон типа "Регулярное выражение":

RegExp нужно вводить в поле как обычное регулярное выражение, но оно должно быть таким, чтобы поддерживался промежуточный ввод. Например:

^\d{1,2}\/\d{1,2}\/\d{4}$ - не поддерживается, т.к. предполагает одновременное наличие минимум 6 символов.

^\d{0,2}\/?\d{0,2}\/?\d{0,4}$ - поддерживается, т.к. допускает промежуточный ввод.

^\d{1,2}\/?\d{0,2}\/?\d{0,4}$ - тоже поддерживается, т.к. первым символом будет введено число - и строка будет соответствовать RegExp.

Для правильной интерпретации следует добавлять в начало выражения - ^, а в конец - $.


В целом, шаблон типа "Маска" следует использовать для более строгих форматов, а RegExp - для более открытых (только цифры, буквы и т.п.)

maskType строка нет pattern нет нет Тип маски ввода. Содержит строку, по которой определяется тип маски - шаблон библиотеки IMask или RegExp.

Выбор даты (datepicker)

Компонент ввода даты. При помощи атрибутов minvalue, maxvalue позволяет задавать период дат.

Атрибуты minvalue, maxvalue, value могут принимать значение даты в виде строки (без формулы) в формате: DD.MM.YYYY или DD.MM.YYYY HH24:MI:SS

Выбор даты 2.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступен из скрипта Описание
kind перечислимый нет date нет да Формат даты:
  • date - выбор даты
  • datetime- выбор даты со временем
  • yearmonth - выбор года и месяца (доступно в iOS)
  • datetimeWithoutSeconds - выбор даты со временем без секунд
minvalue число нет да да Минимально возможная дата доступная для выбора
maxvalue число нет да да Максимально возможная дата для выбора

Выбор времени (timeedit)

Компонент ввода времени в минутах. Минимальное значение - 0, максимальное значение - 999 * 60 + 59 = 59999.

Выбор времени 2.png

Выбор цвета

Выпадающий список (combobox)

Компонент для выбора единственного значения из выпадающего списка.

Выпадающий список.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
keytype строка нет number нет нет Тип ключевого значения.

Возможные значения: "string", "number".

selectedText строка только для чтения да Отображаемое текстовое значение
withUserItems булеан нет false нет нет Добавлять значения вручную. Позволяет добавлять в список значения путем ввода в поле поиска
rowstyle строка нет - - - Название колонки со стилями для раскрашивание элементов в списке
selectedRowStyle строка нет - - - Название колонки со стилями для раскрашивания активного элемента в списке

Выпадающий список с галками (checkcombobox)

Компонент для выбора множественных значений из выпадающего списка.

Выпадающий список с галками.png

Свойства

Значения выпадающего списка описываются одним из способов:

  • вложенным тегом item, атрибуты которого key/value содержат соответственно ключ и значение списка
  • указанием источника данных в атрибуте source

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

  • Установкой атрибута selected для вложенного тега item
  • Перечислением через запятую всех выбранных ключей в теле selected для checkcombobox
Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
selected строка нет да да Перечисление через запятую выбранных ключей
selectedLabels строка нет да Перечисление через запятую с пробелом текстовых наименований выбранных ключей
sourceFillings строка нет да да Строка описывающая обогащение полей курсора указанного в свойстве sourceExt. Обогащение происходит данными из курсора указанного в свойстве source.

Запись происходит в сл. формате: Поле_1_курсор_1: Поле_1_курсор_2 ; ... ; Поле_2_Куроср_1: Поле_2_курсор_2.

Здесь Поле_1_курсор_1, ..., Поле_2_Куроср_1 наименование полей курсора из свойства source, а поля Поле_1_курсор_2, ... , Поле_2_курсор_2 - поля курсора из свойства sourceExt.

Если наименования соответствующих полей совпадают, то есть Поле_1_курсор_1 = Поле_1_курсор_2, то допустпима короткая запись: Поле_1_курсор_1 ; ... ; Поле_2_Куроср_1.

Выбор из справочника (quicksearch)

Компонент поиска данных.

Строка поиска aka QuickSearch предназначена для быстрого и наглядного поиска и выбора пользователем требуемой записи в наборе данных. QuickSearch представляет собой строку ввода, которая используется для отображения текстового описания найденной записи и ввода подстроки для поиска по текстовому полю набора данных. QuickSearch в определенных случаях выводит на экран модальное диалоговое окно, отображающее полностью или частично набор данных и позволяющее выбрать нужную запись. Чтобы начать поиск в наборе данных пользователь вводит подстроку для поиска по текстовому полю и нажимает клавишу <Enter>. Поиск ведется независимо от регистра символов введенной подстроки. В случае, если найден только одна запись, подходящая по условию вхождения подстроки, она становится выбранной, и полное значение текстового поля набора данных отображается в строке QuickSearch. Если подходящая запись не найдена или таких записей найдено более одной, открывается диалоговое окно, отображающее набор данных отфильтрованный по заданному критерию (вхождение подстроки в значение текстового поля). В окне пользователь выбирает нужную запись или задает новый критерий поиска, вводя символы в строку ввода вверху окна. Для начала поиска записи в диалоговом окне пользователь нажимает клавишу <Enter> или кнопку "Найти".

Выбор из справочника (компонент).png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
onsearch действие нет да да Название действия (action), осуществляющее поиск по базе. Действие может быть только единичным и содержать поля поиска по идентификатору (selected) и по значению (selectedText)
selectedText 
searchText
строка только чтение Строка поиска
sourcekey строка нет нет нет Название колонки курсора, содержащей ключевое значение, и параметра app-функции, в котором передается ключевое значение при поиске в режиме QSMODE=ID.
sourcevalue строка нет нет нет Название колонки курсора, содержащей значение текста, и параметра app-функции, в котором передается текстовое значение для поиска в режиме QSMODE=NAME.

Не рекомендуется использовать колонки со значениями атрибута displayformat равными check и icon ввиду невозможности их представления в текстовом виде в поле ввода.

minChars число нет 0 нет да Наименьшее количество символов, которое требуется ввести в строке для начала поиска в базе данных.

Многострочное поле (memo)

Компонент для ввода текстовых данных.

Многострочное поле.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступен из скрипта Описание
maxlength число нет 0 нет да Наибольшая возможная длина текста. Если введено число символов больше, чем заданная максимальная длина, то текст обрезается до размера, указанного в maxlength.

В случае отсутствия этого атрибута или его нулевого или отрицательного значения длина текста ничем не ограничена.

immediateChange булеан нет false нет нет Требование XM-документу реагировать на каждое изменение содержимого строки ввода и немедленно производить соответствующие расчеты.
lines число нет нет да Количество строк для компонента. Получается из стиля.

Редактирование HTML

Компонент для редактирования HTML-страниц.

Наследует все атрибуты от <текстовое поле ввода (memo)> .

Редактирование HTML.png

Галочка (Checkbox)

Компонент для выбора, позволяющий пользователю управлять параметром с двумя состояниями — ☑ включено и ☐ выключено.

Галочка.png

График (chart)

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

График.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
source строка да нет да Курсор в котором отображаемые данные
kind перечислимый нет columnDiagram нет да Определяет тип графика по умолчанию:
  • columnDiagram - гистограмма
  • barDiagram - панельная гистограмма
  • lineDiagram - график
  • areaDiagram - диаграмма участка
  • pieDiagram - круговая диаграмма
kindSelector булеан нет true нет да Определяет возможность пользователем выбирать тип графика:
  • true - есть возможность выбора
  • false - нет возможности выбора
yCaption строка нет да нет Наименование оси Y
legendPosition перечислимый нет bottom нет нет Определяет место отображения легенды графика
  • top - сверху
  • bottom - снизу
  • left - слева
  • right - справа
  • none - не отображать
chartColors строка нет нет нет Строка - список цветов разделенных запятой
dataLabel перечислимый нет 'none' нет нет Отображение метки около точки (столбца, сектора) графика
  • name - отображать только имя
  • namevalue - имя и значение
  • value - только значение
  • none - не отображать ничего
dataLabelBgColor строка нет нет нет Цвет фона метки
dataLabelColor строка нет нет нет Цвет текста метки
dataValueFormat строка нет нет нет Формат значения выводимого в метке

Значение графика (value)

Характеризует величину (показатель) отображаемую в графике.

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Описание
sourcefield строка да Название отображаемой колонки курсора
groupSummaryKind перечислимый да sum() Определяет аналитическую функцию используемую при группировке данных:
  • sum() - суммарное значение
  • min() - минимальное значение
  • max() - максимальное значение
  • count() - общее количество
  • avg() - среднее значение
caption строка да Название величины. Будет отображаться в легенде.

Группировка графика (group)

Характеризует величину (показатель) по которому выполняется группировка данных. Графически отображаются в панели "Уровни данных". Панель отображается, если количество группировок более 1.

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Описание
sourcefield строка да Название колонки курсора по значениям которой выполняется группировка
caption строка да Название величины. Будет отображаться в панели "Уровни данных"
p-step строка нет Шаг для отображения данных на графике (для чисел и дат )

Значения для дат ( 'day', 'month', 'year', 'hour' )

Значения для чисел ( интервал в виде числа )

Если указан шаг то данные отображаем во всем интервале, от минимального значения к максимальному, с данным шагом.

p-from строка нет Конечное значение для интервала данных

Дата ( Пример - '10.07.2014' )

Число ( пример - '120' )

Формула (пример - '${VAR.PARAM}')

p-to строка нет Начальное значение для интервала данных

Дата ( Пример - '10.02.2014' )

Число ( пример - '12' )

Формула (пример - '${VAR.PARAM}')

Картинка (Image)

Картинка.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступен из скрипта Описание
stretch строка нет 0|false нет да Растягивать картинку до размера визуального компонента.

Возможные значения "1"|"true" или "0"|"false" (независимы от регистра).

Примечание: если при обращении к этому атрибуту его значение в строковом виде равно "1" или "true", то оно принимается за true, в случае любых других значений включая пустую строку или NULL оно принимается за false.

iconname строка нет да да Наименование иконки из репозитория для отображения на кнопке
source строка нет да Указывается формула на поле датасета содержащее BLOB с изображением.  (ITMKERNEL-3917) Если заполнено source, то iconname игнорируется

Просмотр HTML (htmlviewer)

Компонент для просмотра html разметки.

Просмотр html .png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
value любой тип нет пусто да да Значение поля ввода

Сравнение текстов (comparison)

Предназначен для визуального сравнения двух передаваемых текстов.

Сравнение текстов.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
showAll булеан нет нет да Отображать текст полностью
rightSide строка да да да Текст правой стороны
leftSide строка да да да Текст левой стороны

Карта (mapView)

Отображает интерактивную карту с возможностью размещать на ней точки, линии (в том числе состоящие из множества отрезков) и многоугольники.

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

Карта.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
source строка да нет нет Источник данных (датасет) для отображения объектов на карте
fit булеан нет нет нет Автоматически изменять позицию и масштаб карты для оптимального отображения всех объектов. При установке атрибута fit=true атрибуты latitude, longitude и zoom игнорируются.
latitude число нет нет нет Начальное положение центра карты по широте. Атрибут игнорируется, если fit=true.
longitude число нет нет нет Начальное положение центра карты по долготе. Атрибут игнорируется, если fit=true.
zoom число нет нет нет Начальное значение масштаба карты. Атрибут игнорируется, если fit=true.

Принимаемые значения: целые и дробные числа от 0 (мир) до 23 (улица/дом).

allowMove булеан нет нет нет Разрешать ли пользователю перемещение по карте
allowZoom булеан нет нет нет Разрешать ли пользователю изменять масштаб карты
dragAction строка нет нет нет Название действия, запускаемого сразу после перетаскивания пользователем объекта на карте.

Доступ к свойствам перемещённого объекта осуществляется через обращение к свойствам <имя компонента карты>.selectedObject.<id|name|object_class|latitude|longitude>.

Если не указано, перетаскивание объектов на карте недоступно.

selectedObject.id целое число только чтение нет да Идентификатор объекта
selectedObject.name строка только чтение нет да Отображаемое наименование объекта
selectedObject.object_class строка только чтение нет да Тип объекта — point, line или polygon
selectedObject.latitude число только чтение нет да Координаты (широта)
selectedObject.longitude число только чтение нет да Координаты (долгота)

Описание формата датасета

Для работы компонента используемый датасет должен иметь соответствующий формат:

Название атрибута строки датасета Тип данных Описание Пример
ID целое число Идентификатор объекта
OBJECT_CLASS строка Тип объекта:
  • point — точка
  • line — отрезок
  • polygon — многоугольник
ACTIONCLASS строка Название действия, выполняемое при нажатии на объект
NAME строка Отображаемое наименование объекта
POINTS строка Координаты объекта.

Двумерный массив, содержащий массив(ы) пар координат (долгота, широта).

  • Точка: [[87.18613, 53.99818]]
  • Прямая линия (2 точки): [[87.18613,53.99818], [87.18613,53.99818]]
  • Ломаная линия (от 3 точек): [[87.18613,53.99818], [87.18613,53.99818], [87.19036,53.99834], [87.19947,53.99891]]
  • Многоугольник (если начальная и конечная точки не совпадают, они будут автоматически соединены ещё одним отрезком): [[87.7959426611866, 49.26152638335681], [98.9204449286504, 52.05763105135641], [116.44619710420787, 49.98618250048632], [113.77383063772218, 44.77401901529287], [96.4345226342451, 42.7089399393454], [89.59823632463048, 47.821523331564144]]
STYLE строка (JSON) JSON, содержащий набор свойств, описывающих внешний вид объекта. Содержимое зависит от типа объекта — некоторые свойства у точек, отрезков и полигонов различаются, некоторые совпадают.
  • captionVisibilityLevel (число 0/1/2) Видимость отображаемого наименования объекта. 0 — не отображать, 1 — отображать при наведении мыши, 2 — отображать всегда. Применимо к точкам и полигонам.
  • color (цвет в hex-формате в строковом представлении) Для point и polygon — цвет границы (border) Для line — цвет отрезка
  • backgroundColor (такой же формат, как у color) Цвет заливки
  • opacity (дробное число в диапазоне с 0 по 1) Прозрачность объекта
  • iconUrl (строка) Относительный или абсолютный url до файла изображения, которое будет использовано в качестве иконки маркера точки или размещено в центре полигона.
  • thickness (целое число) Толщина отрезка в пикселах

Итого, использование свойств по типам объектов:

  • point:
    • captionVisibilityLevel
    • color
    • backgroundColor
    • opacity
    • iconUrl
  • line:
    • color
    • thickness
    • opacity
  • polygon:
    • captionVisibilityLevel
    • color
    • backgroundColor
    • opacity
    • iconUrl
  • Точка со всегда отображаемым наименованием, заданными цветами фона, обводки, частичной прозрачностью и иконкой: {"captionVisibilityLevel": 2, "color": "#1c0f80", "backgroundColor": "#fdf877", "opacity":0.75, "iconUrl":"http://10.144.18.109:8083/extra-media/char1.png"}

Дерево группировки грида (gridGroupingTree)

Компонент для отображения группировки грида в виде отдельного дерева.

Дерево группировки грида.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание 
gridname
строка нет нет нет Имя грида, к которому привязано дерево в формате Window.gridName
groupby строка нет да нет Колонки для группировки. Cписок имен колонок по которым будет сформировано дерево фильтра, через запятую
showExpandCollapseButtons логический нет false нет нет Кнопки свернуть всё / развернуть всё

Дерево

Компонент для отображения данных датасета в виде дерева.

Дерево.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
sourceparent строка нет нет нет Колонка, содержащая id родительского узла
onrowselect строка нет да нет Действие при выборе строки
sourceicon строка нет нет нет Колонка с иконкой. Имя колонки грида с id иконок
sourceloadondemand строка нет нет нет Колонка для подзагрузки. Имя колонки, содержащей флаг необходимости подгрузить строки

Допустимые значения в датасете:

0 - без подзагрузки

1 - Полная загрузка

2 - Загрузка с фильтрацией (пользователю показывается окно с текстовым вводом)

onsearch строка нет нет нет Действие для подзагрузки (единичное действие, возвращающее датасет)

К параметрам заданным в дизайнере будет добавлено еще 2

ID - содержит id ноды, для которой загружаем данные

TEXT - текст введенный пользователем для фильтрации

showExpandCollapseButtons логический нет false нет нет Кнопки свернуть всё / развернуть всё

Cтрока поиска (searchBox)

Даёт возможность поиска по тексту, отображаемому в дереве

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Описание
caseSensitive булеан нет false Регистрозависимый поиск
showCaseSensitiveButton булеан нет false Отображать кнопку регистрозависимого поиска
useRegexp булеан нет false Использовать регулярное выражение
showUseRegexpButton булеан нет false Отображать кнопку для регулярного выражения
showClearSearchFieldButton булеан нет true Отображать кнопку очистки строки поиска

Диаграмма Ганта

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

Для работы необходимо предоставить компоненту два специально подготовленных набора данных (датасета). Первый формирует табличную часть (слева), второй — диаграмму (справа).

Диаграмма Ганта.png

Свойства таблицы и графика задаются в дочерних тегах:

1. График диаграммы (chart)

Настраивает отображение графика в диаграмме Ганта

Свойства

Название атрибута Тип данных Обязательность Может содержать скрипт Значение по умолчанию Описание
source строка да Название курсора из action, содержащей данные для отображения на диаграмме
fk строка да Название колонки курсора, содержащее первичный ключ

Тип данных колонки должен быть число

timeStart строка да Начальная позиция отрезка, размещаемого на временной диаграмме

Тип данных колонки должен быть дата

timeEnd строка да Конечная позиция отрезка

Тип данных колонки должен быть дата

label строка да Текст, отображаемый на элементе диаграммы

Тип данных колонки должен быть строка

zoom число нет да 15 Масштаб отображения диаграммы. Число с плавающей точкой в диапазоне с 10 (максимально подробный масштаб) по 22 (самый сжатый вид).

2. Таблица диаграммы (table)

Используется для настройки табличной части диаграммы Ганта. Содержит вложенные теги для описания колонок таблицы.

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Описание
source строка да Название курсора из action, содержащей данные для отображения в таблице
id строка да Название колонки курсора, содержащее первичный ключ

Тип данных колонки должен быть число

Источник — http://xmdocs.intellex.ru/index.php?title=Визуальные_компоненты&oldid=2510