Функции электронных таблиц

В этом разделе описаны функции, связанные с электронной таблицей, доступные в контекстах модели.

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

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

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

Получить электронную таблицу

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

Имя функции:

spreadsheetGet

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Входные записи:

1

Входной формат:

 

 

 

Имя

Тип

Описание

id

String

Идентификатор сессии электронной таблицы.

includeCells

Boolean

True, если данные ячеек должны быть включены в ответ.

ranges

Data Table

Необязательный список диапазонов ячеек (см. Диапазон).

Выходные записи:

1

Выходной формат:

см. Данные электронной таблицы

Обновить электронную таблицу

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

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

Имя функции:

spreadsheetUpdate

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Входные записи:

1

Входной формат:

 

 

 

Имя

Тип

Описание

id

String

Идентификатор сеанса электронной таблицы.

cells

Data Table

Список ячеек с данными (см. Ячейка). Если указан, существующие ячейки удаляются и заменяются.

mergedRanges

Data Table

Список объединенных диапазонов ячеек (см. Диапазон). Если указан, существующие объединенные диапазоны удаляются и заменяются.

mergeCells

Data Table

Список диапазонов, которые необходимо объединить (см. Диапазон).

unmergeCells

Data Table

Список диапазонов, которые необходимо разъединить (см. Диапазон).

groups

Data Table

Список групп (см. Группа). Если указан, существующие группы удаляются и заменяются.

addGroups

Data Table

Список групп для добавления (см. Группа).

removeGroups

Data Table

Список групп для удаления (см. Группа).

updateGroups

Data Table

Список групп для обновления (см. Группа).

updateColumnsMetadata

Data Table

Обновленные метаданные столбца (см. Свойства измерения).

updateRowsMetadata

Data Table

Обновлены метаданные строк (см. Свойства измерения).

columnsMetadata

Data Table

Полные метаданные столбца, которые необходимо установить (см. Свойства измерения).

rowsMetadata

Data Table

Полные метаданные строки, которые необходимо задать (см. Свойства измерения).

insertDimension

Data Table

Данные операции вставки измерения (см. Диапазон измерений / Свойства измерения).

moveDimension

Data Table

Данные операций перемещения измерения.

deleteDimension

Data Table

Данные операции удаления измерения (см. Диапазон измерений / Свойства измерения).

addConditionalFormat

Data Table

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

updateConditionalFormat

Data Table

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

deleteConditionalFormat

Data Table

Сущности условного форматирования, которые необходимо удалить (см. Условное форматирование).

insertRange

Data Table

Диапазон данных операции вставки (см. Диапазон).

deleteRange

Data Table

Данные операции удаления диапазона (см. Диапазон).

Выходные записи:

Нет

Выходной формат:

Нет

Получить ячейки электронной таблицы

Эта функция используется для возврата данных ячеек электронной таблицы для указанных диапазонов.

Имя функции:

spreadsheetCellsGet

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Входные записи:

1

Входной формат:

 

 

 

Имя

Тип

Описание

id

String

Идентификатор сеанса электронной таблицы.

ranges

Data Table

Список диапазонов, данные ячеек которых должны быть возвращены (см. Диапазон).

Выходные записи:

0…Не ограничено

Выходной формат:

см. Ячейка

Обновление ячеек таблицы

Эта функция используется для обновления данных ячеек таблицы.

Имя функции:

spreadsheetCellsUpdate

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Требуемый уровень прав доступа зависит от того, какие части ячейки обновляются:

  • Оператор для обновления значений

  • Инженер для обновления привязок

  • Менеджер — для стилей, форматов и комментариев

  • Инженер, если обновление изменяет поведение режима «только для чтения».

Записи ввода:

1

Входной формат:

 

 

 

Название

Тип

Описание

id

String

Идентификатор сеанса электронной таблицы.

cells

Data Table

Список ячеек с данными, которые необходимо обновить (см. Ячейка).

Выходные записи:

Нет

Выходной формат:

Нет

Очистка ячеек электронной таблицы

Эта функция используется для очистки ячеек электронной таблицы в указанных диапазонах.

Имя функции:

spreadsheetCellsClear

Права доступа:

Доступно на уровне прав доступа Менеджер. Когда требуется очистка ячеек, содержащих привязки, необходим уровень прав доступа Инженер.

Входные записи:

1

Входной формат:

 

 

 

Имя

Тип

Описание

id

String

Идентификатор сессии электронной таблицы.

cells

Data Table

Список диапазонов, ячейки которых необходимо очистить (см. Диапазон).

Выходные записи:

Нет

Выходной формат:

Нет

Обновление значений в электронной таблице

Эта функция используется для обновления значений ячеек электронной таблицы.

Имя функции:

spreadsheetValuesUpdate

Права доступа:

Доступно на уровне прав оператора. Если обновление изменяет поведение режима «неизменяемое», может потребоваться более высокий уровень прав доступа.

Входные записи:

1

Входной формат:

 

 

 

Название

Тип

Описание

id

String

Идентификатор сеанса электронной таблицы.

values

Data Table

Список ячеек со значениями, которые необходимо обновить (см. Ячейка).

Выходные записи:

Нет

Выходной формат:

Нет

Обновить привязки электронной таблицы

Эта функция используется для обновления формул в электронной таблице.

Имя функции:

spreadsheetBindingsUpdate

Права доступа:

Доступно на уровне прав доступа Инженер

Входные записи:

1

Входной формат:

 

 

 

Название

Тип

Описание

id

String

Идентификатор сеанса электронной таблицы.

values

Data Table

Список ячеек с формулами, которые необходимо обновить (см. Ячейка).

Выходные записи:

Нет

Выходной формат:

Нет

Обновить форматы электронной таблицы

Эта функция используется для обновления форматов ячеек электронной таблицы.

Имя функции:

spreadsheetFormatsUpdate

Права доступа:

Доступно на уровне прав Менеджер. Уровень прав Инженер обязателен для заполнения, если обновление изменяет поведение режима «неизменяемое».

Входные записи:

1

Входной формат:

 

 

 

Имя

Тип

Описание

id

String

Идентификатор сеанса электронной таблицы.

values

Data Table

Список ячеек с форматами, которые необходимо обновить (см. Ячейка).

Выходные записи:

Нет

Выходной формат:

Нет

Обновление стилей электронной таблицы

Эта функция используется для обновления стилей ячеек электронной таблицы.

Имя функции:

spreadsheetStylesUpdate

Права доступа:

Доступно на уровне прав доступа Менеджер

Входные записи:

1

Входной формат:

 

 

 

Имя

Тип

Описание

id

String

Идентификатор сеанса электронной таблицы.

values

Data Table

Список ячеек со стилями, которые необходимо обновить (см. Ячейка).

Выходные записи:

Нет

Выходной формат:

Нет

Обновить комментарии в электронной таблице

Эта функция используется для обновления комментариев в электронной таблице.

Имя функции:

spreadsheetCommentsUpdate

Права доступа:

Доступно на уровне прав доступа Менеджер

Входные записи:

1

Входной формат:

 

 

 

Имя

Тип

Описание

id

String

Идентификатор сеанса электронной таблицы.

values

Data Table

Список ячеек с комментариями, которые необходимо обновить (см. Ячейка).

Выходные записи:

Нет

Выходной формат:

Нет

Вычисление электронной таблицы

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

Имя функции:

spreadsheetEvaluate

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Входные записи:

1

Входной формат:

 

 

 

Название

Тип

Описание

id

String

Идентификатор сеанса электронной таблицы.

ranges

Data Table

Список диапазонов, формулы которых необходимо пересчитать (см. Диапазон). Если диапазон не указан, будут пересчитаны выражения всех ячеек.

Результатные записи:

Нет

Выходной формат:

Нет

Экспорт таблицы

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

Имя функции:

spreadsheetExport

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Входные записи:

1

Входной формат:

 

 

 

Имя

Тип

Описание

name

String

Имя таблицы.

context

String

Путь к контексту экземпляра модели. Если не указано, используется путь контекста текущей модели.

fileType

Integer

Формат экспорта. Поддерживаемые значения:

0 - .tbl

3 - .csv

6 - .pdf

7 - .xlsx

exportFormula

Boolean

Управляет способом экспорта формул когда они экспортируются fileType используется формат .xlsx.

Возможные значения:

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

false — экспортированные ячейки содержат только статические расчетные значения.

Когда fileType значение .pdf, формулы не сохраняются; экспортируются только расчетные значения.

Выходные записи:

1

Выходной формат:

 

 

 

Название

Тип

Описание

data

Данные

Блок данных с экспортированными данными из электронной таблицы.

Импорт из электронной таблицы

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

Имя функции:

spreadsheetImport

Права доступа:

Доступно на уровне прав доступа Инженер

Входные записи:

1

Входной формат:

 

 

 

Название

Тип

Описание

id

String

Идентификатор сеанса электронной таблицы.

data

Данные

Data Block с импортированными данными таблицы.

override

Boolean

Если значение true и таблица с таким же идентификатором уже существует, её данные заменяются. Если значение false, функция возвращает ошибку.

context

String

Путь к контексту экземпляра модели.

fileName

String

Имя и расширение импортируемого файла. Поддерживаемые форматы:

  • .tbl

  • .csv

  • .xlsx

importOptions

Data Table

Опции импорта из CSV. Используются только при импорте данных из файла .csv.

Выходные записи:

Нет

Выходной формат:

Нет

Сохранение электронной таблицы

Эта функция используется для сохранения данных электронной таблицы.

Имя функции:

spreadsheetSave

Права доступа:

Доступно на уровне прав доступа оператора

Входные записи:

1

Входной формат:

 

 

 

Имя

Тип

Описание

id

String

Идентификатор сеанса электронной таблицы.

ranges

Data Table

Список диапазонов для сохранения (см. Диапазон).

Выходные записи:

Нет

Выходной формат:

Нет

Сортировка электронной таблицы

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

Имя функции:

spreadsheetSort

Права доступа:

Доступно на уровне прав доступа Менеджер

Входные записи:

1

Входной формат:

 

 

 

Имя

Тип

Описание

id

String

Идентификатор сеанса электронной таблицы.

sortingParameter

Data Table

Параметр сортировки (см. Параметр сортировки).

Выходные записи:

Нет

Выходной формат:

Нет

Was this page helpful?