Общие функции

Текущий раздел описывает функции, доступные в компонентах, основанных на компоненте Data Table.

Удалить строку

Удаляет строки из таблицы данных, указанные по индексам, указанным в аргументе Index.

Имя функции: removeRows

Аргументы:

Поле

Тип поля

Описание поля

Index

Data Table

Таблица данных с одним полем Index типа String. В каждой строке указывается индекс строки, которую необходимо удалить из таблицы данных.

Добавить строку

Вставляет таблицу данных, указанную в аргументе Row, в позицию индекса, указанную в аргументе Index.

Имя функции: addRow

Аргументы:

Поле

Тип поля

Описание поля

Index

Integer

Индекс строки, указывающий, куда необходимо добавить новую строку.

Row

Data Table

Таблица данных, содержащая данные для вставки в таблицу данных. Формат таблицы данных Row должен совпадать с форматом таблицы данных, в которую добавляется строка.

Сортировка разрешена

Перемещает одну или несколько записей внутри компонента Data Table на основе их идентификаторов записей (Record ID). Поддерживает валидацию и работу с вложенными данными.

Имя функции: reorderRecord

Аргументы:

Поле

Тип поля

Описание поля

Record IDs

Data Table

Таблица данных, содержащая идентификаторы записей для перемещения. Идентификаторы могут быть UUID или значениями, указанными в свойстве Имя столбца идентификатора записи (Record ID Column Name)

Reorder ID

String

Указывает строку, перед которой будет вставлена перемещаемая запись. Может быть UUID или значением из Record ID Column Name. Если null, запись вставляется в конец

Parent ID

String

Указывает новый родительский идентификатор записи при использовании вложенных данных. Может быть UUID или значением из Parent Record ID Column Name. Может быть null, если смена родителя не требуется

Validation Field

String

(Необязательно) Имя поля для проверки уникальности при перестановке. Если в целевой области уже существует запись с таким же значением в этом поле, операция блокируется и пользователю выводится предупреждение

Если параметр Validation Field не указан, записи перемещаются без проверки.

В случае неуспешной проверки перестановка не выполняется и выводится сообщение.

Данная функция заменяет устаревшие параметры (Index, After), которые больше не используются.

Обновить ячейку

Обновляет ячейку, указанную аргументами Index и Field, значением, указанным аргументом Value.

Имя функции: updateCell

Аргументы:

Поле

Тип поля

Описание поля

Index

String

Индекс строки ячейки, которую необходимо обновить.

Field

String

Имя поля ячейки для обновления.

Value

Data Table

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

Тип данных поля value должен быть таким типом, который может быть приведен к типу обновляемой ячейки.

Следующий пример иллюстрирует один из способов вызова функции updateCell:

  • Рассмотрим компонент Таблица данных с именем dataTableComponent0, имеющий по крайней мере одну существующую строку и поле exampleField

  • Мы хотим обновить значение ячейки в первой строке поля exampleField со строкой “this is the new field value” («это новое значение поля»).

Выражение используется в привязке в контексте инструментальной панели, где находится dataTableComponent0:

{form/dataTableEditorUpdateCell:updateCell("1","exampleField",'array("value", "This is the new field value")')}

Выражение можно разбить на части следующим образом:

  • form/dataTableComponent0 — схема form/ обозначает компонент инструментальной панели, а dataTableComponent0 указывает на конкретный компонент

  • :updateCell Указывает, что функция updateCell вызывается из компонента

  • Функция имеет следующие аргументы:

    • "1" - строка таблицы данных для обновления

    • "exampleField" - поле таблицы данных для обновления

    • 'array("value", "This is the new field value")' Создает таблицу данных с одним полем value типа String и одну строку с данными "This is the new field value"

Выбрать строку

Выбрать или отменить выбор определенной строки в таблице данных на основе Record Index. Индекс записи может быть либо UUID строки, либо значением в поле таблицы данных, указанным в имени столбца идентификатора записи.

Эту функцию также можно использовать для выбора всех строк, отмены выбора всех строк или смены состояния выбора всех строк на противоположное в таблице данных.

Имя функции: rowSelected

Аргументы:

Поле

Тип поля

Описание поля

Record Index

String

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

Selection Type

Integer

Указывает тип операции выбора, которая будет применена к строке или таблице. Доступны следующие параметры:

  • 0 — отменить выбор строки, указанной аргументом Record Index. Состояние выбора всех остальных строк не изменится.

  • 1 — выбрать строку, указанную аргументом Record Index. Состояние выбора всех остальных строк не изменится.

  • 2 — отменить выбор всех строк в таблице, аргумент Record Index игнорируется.

  • 3 — выбрать все строки в таблице, аргумент Record Index игнорируется.

  • 4 — изменить состояние выбора всех строк в таблице на противоположное. Выбор всех выбранных строк будет отменен, а все невыбранные будут выбраны. Аргумент Record Index игнорируется.

Получить выбранные строки

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

Имя функции: getSelectedRows

Аргументы:

None

Возвращает:

Поле

Тип поля

Описание поля

Key

String

UUID выбранных строк.

Перезагрузить

При вызове функции reset() для таблицы данных все выбранные строки возвращаются в исходное состояние. Это означает, что все введенные пользователем значения отбрасываются и заменяются исходными значениями. Любая фильтрация или сортировка, примененная к таблице пользователем, возвращается в состояние по умолчанию.

Имя функции: reset

Аргументы:

None

Возвращает:

None

Was this page helpful?