spreadsheet_write

W · записьпо подпискеизменяет проект

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

Когда использовать

Заполнить шапку и строку таблицы печатной формы — пачка по адресу <макет>.Cell.
Поменять одну ячейку — update по адресу ….Cell.RnCm; новая ячейка создаётся так же.
Разметить области для ПолучитьОбласть в коде печати — create по адресу ….Area.<Имя>.
Создать сам макет — metadata_write.

Соседние инструменты домена «Макеты»

spreadsheet_readRсостав, сетка, карточка ячейки; #help — контракт записи

Операции

Операции spreadsheet_write
operation	Что делает	Нужно передать
`create`	Именованная область с границами `bbox`.	`project`, `fqn` — `….Area.<Имя>`, `definition.bbox`
`update`	Ячейка — дельта содержимого и оформления; коллекционный адрес `….Cell` с массивом — пачка ячеек и диапазонов; голый адрес макета с `parameters` — параметры пачкой; область — новые границы или имя.	`project`, `fqn`, `definition`
`delete`	Удаляет именованную область.	`project`, `fqn` — `….Area.<Имя>`

Параметры

Параметры spreadsheet_write
Параметр и тип	Обязательный	Описание	По умолчанию
`project`строка	да	Идентификатор проекта рабочей области EDT — имя из ответа project_read (например, УТ2020). Для расширения — проект расширения.	—
`operation`строка	да	Операция инструмента — значения и их смысл в таблице «Операции».значения: create · update · delete	—
`fqn`строка	да	Цель: `<макет>.Cell.RnCm` — ячейка; `<макет>.Cell` — пачка ячеек; `<макет>.Area.<Имя>` — область; `<макет>` с `parameters` — параметры. Координаты с единицы.	—
`definition`объект \| массив	нет	Ячейка: `fill` (`Текст`, `Параметр`, `Шаблон`) и `text` или `parameter`, `horizontalAlignment` и `verticalAlignment` (`Лево`, `Право`, `Центр`, `Верх`, `Низ`), `font` (`Arial,9,bold`), `backColor`, `textColor` (`#RRGGBB`), `merge` (`RnCm:RnCm`, `null` снимает). Пачка — массив элементов с `cell` (адрес или диапазон): до 100 элементов и 1000 ячеек, всё или ничего. Область — `bbox`, `name`. Контракт — `spreadsheet_read` с гранью `#help`.	—
`dry_run`булево	нет	true — выполнить в транзакции и гарантированно откатить: ответ показывает изменения, макет не меняется.	`false`
`title`строка	нет	Необязательная подпись вызова до 40 символов: клиент показывает её в шапке карточки вызова. На результат не влияет.	—

Таблица собрана из схемы инструмента, которую получает агент при подключении.

Адреса

Адреса spreadsheet_write
Адрес	Что адресует
`Document.РеализацияТоваровУслуг.Template.<Макет>.Cell.R4C5`	одна ячейка
`Document.РеализацияТоваровУслуг.Template.<Макет>.Cell`	пачка ячеек
`Document.РеализацияТоваровУслуг.Template.<Макет>.Area.Заголовок`	именованная область

Пример вызова и ответа

Строки Changes пачки начинаются с адреса ячейки; диапазон сворачивается в одну строку с числом ячеек.

аргументы spreadsheet_write

{
  "project": "УТ2020",
  "operation": "update",
  "fqn": "Document.РеализацияТоваровУслуг.Template.<Макет>.Cell",
  "definition": [
    { "cell": "R2C1", "text": "Номенклатура", "font": "Arial,9,bold" },
    { "cell": "R2C2", "text": "Количество", "font": "Arial,9,bold" },
    { "cell": "R4C1", "fill": "Параметр", "parameter": "Номенклатура" },
    { "cell": "R2C1:R2C9", "backColor": "#EEEEEE" }
  ]
}

Пример ответа в подготовке Устройство ответа — на странице Формат ответов.

Отказы и ошибки

rolled_back · вид заполнения не совпадает с содержимым

fill: Текст требует text, fill: Параметр — parameter, fill: Шаблон — text со встроенными [Имя]. Несовпадение — отказ всей пачки с номером виновного элемента.

rolled_back · объединение на диапазоне

merge задаётся от одной ячейки-якоря, а не для диапазона в пачке.

failed · Unknown operation

Неизвестное значение operation. В ответе — fix_hint: supported: … со списком допустимых операций и секция Did you mean. Допустимо: create, update, delete.

failed · лицензия

Без действующего ключа инструмент отвечает карточкой failed с сообщением лицензия: … и подсказкой, где ввести ключ; в секции Context — список инструментов, доступных без ключа. Подробнее — Лицензия и бесплатный доступ.

Ограничения

Пачка — до 100 элементов и 1000 ячеек, атомарно; пересекающиеся элементы применяются по порядку, последний выигрывает.
Вставка строк со сдвигом и рисунки — вне инструмента: это делает человек в редакторе EDT.
После записи проверяйте результат чтением: spreadsheet_read по той же ячейке или #layout.