Инструменты · Макеты
spreadsheet_read
Читает макет табличного документа — состав (области, объединения, параметры, рисунки), визуальную сетку строк и колонок, карточку ячейки с содержимым и оформлением. Грань #help — контракт spreadsheet_write для адреса.
Когда использовать
- Понять устройство печатной формы перед правкой — состав и сетка
#layout. - Проверить ячейку после записи — карточка
….Cell.R4C5. - Найти все параметры макета, в том числе встроенные в шаблоны
[Имя], — срез….Param.
Соседние инструменты домена «Макеты»
Операции
Параметра operation у инструмента нет: что вернуть, задаёт адрес fqn — маркер-хвост и грань после #.
| Адрес или грань | Что возвращает |
|---|---|
<макет> | Состав: области, объединения, параметры, рисунки; синоним грани — #source |
<макет>#layout | Визуальная сетка строки × колонки; синоним #разметка |
<макет>#properties | Свойства документа; синоним #свойства |
<макет>.Cell.R8C2 | Карточка ячейки: содержимое, вид заполнения, выравнивание, шрифт, цвета |
<макет>.Cell.R1C1:R5C3 | Ячейки диапазона |
<макет>.Area.<Имя>, .Param.<Имя>, .Row.N, .Col.N | Область, параметр, строка, колонка |
<макет>.Cell, .Area, .Param | Срез коллекции списком |
<адрес>#help | Контракт definition для spreadsheet_write по адресу |
Параметры
| Параметр и тип | Обязательный | Описание | По умолчанию |
|---|---|---|---|
projectстрока | да | Идентификатор проекта рабочей области EDT — имя из ответа project_read (например, УТ2020). Для расширения — проект расширения. | — |
fqnстрока | да | Адрес макета <Владелец>.Template.<Имя> или CommonTemplate.<Имя> с хвостом и гранью. Координаты — абсолютные RnCm с единицы. | — |
filterстрока | нет | Регулярное выражение без учёта регистра по именам и содержимому строк. | — |
limitцелое | нет | Окно чтения: сколько строк готового ответа вернуть. По умолчанию 200, максимум 1000. | 200 |
offsetцелое | нет | Окно чтения: номер строки ответа, с которой начать (0 — первая страница). Значение для следующей страницы подсказывает строка *lines: …* в конце ответа. | 0 |
Таблица собрана из схемы инструмента, которую получает агент при подключении.
Адреса
| Адрес | Что адресует |
|---|---|
Document.РеализацияТоваровУслуг.Template.<Макет> | состав макета |
Document.РеализацияТоваровУслуг.Template.<Макет>#layout | сетка |
Document.РеализацияТоваровУслуг.Template.<Макет>.Cell.R4C4 | одна ячейка |
Document.РеализацияТоваровУслуг.Template.<Макет>.Param | все параметры |
CommonTemplate.<Макет> | общий макет |
Пример вызова и ответа
Ответ — пример из описания формата ответов: дайджест с размером и счётчиками, затем секции с числом элементов.
{ "project": "УТ2020", "fqn": "Document.РеализацияТоваровУслуг.Template.Печать" }### Document.РеализацияТоваровУслуг.Template.Печать
> Σ 41×9 (R1C1:R41C9) · formats 24 · merges 3 · areas 2 · defaultFormatIndex 0
#### Areas (2)
- Заголовок [Rect] R1C1:R3C9
- ТабЧасть [Rect] R8C1:R20C9
#### Merges (3)
- R1C1:R1C9 (1×9)
- … (2 ещё)
#### Parameters (0)
_(нет)_Отказы и ошибки
Адрес не макета табличного документа
Объекты читает metadata_read, схемы компоновки — dcs_read.
failed · лицензия
Без действующего ключа инструмент отвечает карточкой failed с сообщением лицензия: … и подсказкой, где ввести ключ; в секции Context — список инструментов, доступных без ключа. Подробнее — Лицензия и бесплатный доступ.
Ограничения
- Рисунки в макете только читаются: создавать их может человек в редакторе EDT.