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

[ ? ]

Унаследованные функции

Компонент Электронная таблица внутренне основан на компоненте Data Table и наследует его общие функции.

Пользовательские функции

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

Экспорт данных

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

Имя функции:

exportData

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

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

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

1

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

Имя

Тип

Описание

fileType

Integer

Расширение файла, используемое для экспорта. Поддерживаемые значения:

  • 0 - .tbl

  • 3 - .csv

  • 6 - .pdf

  • 7 - .xlsx

fileName

String

Имя экспортируемого файла.

exportFormula

Boolean

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

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

1

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

Имя

Тип

Описание

filePath

String

Путь к экспортированному файлу таблицы.

Импорт данных

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

Имя функции:

importData

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

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

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

1

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

Название

Тип

Описание

fileName

String

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

  • .tbl

  • .csv

  • .xlsx

importOptions

Data Table

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

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

Нет

Получить таблицу

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

Имя функции:

getSpreadsheet

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

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

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

1

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

Имя

Тип

Описание

includeCells

Boolean

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

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

1

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

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

Сохранить

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

Имя функции:

save

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

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

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

Нет

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

Нет

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

Нет

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

Нет

Получить ячейки

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

Имя функции:

getCells

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

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

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

1

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

Имя

Тип

Описание

ranges

Data Table

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

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

1

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

Название

Тип

Описание

cells

Data Table

Список ячеек с данными (см. Ячейка). В текущей реализации возвращаются только ячейки из первого диапазона.

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

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

Она принимает список ячеек с данными, которые необходимо обновить, и не возвращает никаких выходных параметров.

Имя функции:

updateCells

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

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

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

1

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

см. Ячейка

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

Нет

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

Нет

Очистить ячейки

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

Она принимает список диапазонов, ячейки которых необходимо очистить, и не возвращает никаких выходных параметров.

Имя функции:

clearCells

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

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

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

1

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

см. Диапазон

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

Нет

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

Нет

Обновить значения

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

Она принимает список ячеек, значения которых необходимо обновить, и не возвращает никаких выходных параметров.

Имя функции:

updateValues

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

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

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

1

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

см. Ячейка

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

Нет

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

Нет

Обновить привязки

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

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

Имя функции:

updateBindings

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

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

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

1

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

 

 

 

Название

Тип

Описание

rowIndex

Integer

Индекс строки ячейки.

columnIndex

Integer

Индекс столбца ячейки.

binding

String

Выражение привязки.

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

Нет

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

Нет

Форматы обновления

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

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

Имя функции:

updateFormats

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

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

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

1

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

 

 

 

Имя

Тип

Описание

rowIndex

Integer

Индекс строки ячейки.

columnIndex

Integer

Индекс столбца ячейки.

format

String

Формат ячейки.

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

Нет

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

Нет

Обновить стили элемента

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

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

Имя функции:

updateStyles

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

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

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

1

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

 

 

 

Название

Тип

Описание

rowIndex

Integer

Индекс строки ячейки.

columnIndex

Integer

Индекс столбца ячейки.

styles

Data Table

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

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

Нет

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

Нет

Обновить комментарии

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

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

Имя функции:

updateComments

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

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

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

1

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

 

 

 

Имя

Тип

Описание

rowIndex

Integer

Индекс строки ячейки.

columnIndex

Integer

Индекс столбца ячейки.

comments

Data Table

Данные комментария, которые будут применены к ячейке.

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

Нет

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

Нет

Объединение ячеек

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

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

Имя функции:

mergeCells

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

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

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

1

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

см. Диапазон

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

Нет

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

Нет

Разъединение ячеек

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

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

Имя функции:

unmergeCells

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

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

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

1

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

см. Диапазон

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

Нет

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

Нет

Добавить группы

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

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

Имя функции:

addGroups

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

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

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

1

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

см. Группа

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

Нет

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

Нет

Удалить группы

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

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

Имя функции:

removeGroups

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

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

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

1

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

см. Группа

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

Нет

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

Нет

Обновить группы

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

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

Имя функции:

updateGroups

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

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

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

1

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

см. Группа

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

Нет

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

Нет

Добавить условное форматирование

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

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

Имя функции:

addConditionalFormat

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

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

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

1

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

см. Условное форматирование

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

Нет

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

Нет

Обновить условный формат

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

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

Имя функции:

updateConditionalFormat

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

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

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

1

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

см. Условное форматирование

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

Нет

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

Нет

Удаление условного форматирования

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

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

Имя функции:

deleteConditionalFormat

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

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

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

1

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

см. Условное форматирование

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

Нет

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

Нет

Вычисление

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

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

Имя функции:

evaluate

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

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

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

1

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

см. Диапазон

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

Нет

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

Нет

Получить свойства таблицы

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

Имя функции:

getSpreadsheetProperties

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

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

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

Нет

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

Нет

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

1

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

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

Установить свойства таблицы

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

Имя функции:

setSpreadsheetProperties

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

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

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

1

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

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

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

Нет

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

Нет

Получить условия форматирования форматов

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

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

Имя функции:

getConditionalFormats

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

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

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

1

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

см. Диапазон

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

0…Не ограничено количество

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

см. Условное форматирование

Сортировка

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

Имя функции:

sort

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

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

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

1

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

 

 

 

Название

Тип

Описание

id

String

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

sortingParameter

Data Table

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

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

Нет

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

Нет

Was this page helpful?