Cluster · разработчикам
Canvas
Корневая сцена: размеры 1..2048, не более двух миллионов пикселей, 128 слоёв и 6 уровней вложенности.
Все методы SDK · Типы и ошибки
Получение объекта
canvas = app.images.canvas(800, 400, "#18151f")Наследует Container. Унаследованные методы: add, layer, rect, ellipse, gradient, text, image, group, points, line, polygon, get, remove, order, grid, row, column.
__init__
Создаёт Canvas. Обычный способ получения объекта показан выше; прямой конструктор не выполняет сетевые запросы.
def __init__(width: int = 1200, height: int = 700, background: str | None = None) -> None: ...Аргументы
width: int, по умолчанию1200. Размер в пикселях, конечное число. Canvas требует целые размеры 1..2048; полная геометрия проверяется build().height: int, по умолчанию700. Размер в пикселях, конечное число. Canvas требует целые размеры 1..2048; полная геометрия проверяется build().background: str | None, по умолчаниюNone. Цвет #RRGGBB или #RRGGBBAA; None допускается только для необязательного цвета.
Результат
None. Создаёт Canvas. Обычный способ получения объекта показан выше; прямой конструктор не выполняет сетевые запросы.
Права
Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.
Ошибки
- Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.
Пример
# Обычный способ получения объекта:
canvas = app.images.canvas(800, 400, "#18151f")from_dict
Копирует и проверяет готовое описание сцены, затем создаёт холст.
def from_dict(document: dict) -> Canvas: ...Аргументы
document: dict, обязательный. Готовое JSON-описание сцены, не объект Canvas.
Результат
Canvas. Копирует и проверяет готовое описание сцены, затем создаёт холст.
Права
Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.
Ошибки
- ValueError при неверной сцене, цвете, геометрии или превышении пределов. TypeError/KeyError возможны для структурно неверного описания.
Пример
result = canvas.from_dict(canvas.build())copy
Создаёт независимую проверенную копию всей сцены.
def copy() -> Canvas: ...Аргументы
Нет.
Результат
Canvas. Создаёт независимую проверенную копию всей сцены.
Права
Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.
Ошибки
- ValueError при неверной сцене, цвете, геометрии или превышении пределов. TypeError/KeyError возможны для структурно неверного описания.
Пример
result = canvas.copy()build
Полностью проверяет сцену и возвращает независимый JSON-словарь для генератора. Проверяет ID, геометрию, стили, лимиты текста, пикселей и размер запроса.
def build() -> CanvasData: ...Аргументы
Нет.
Результат
CanvasData. Полностью проверяет сцену и возвращает независимый JSON-словарь для генератора. Проверяет ID, геометрию, стили, лимиты текста, пикселей и размер запроса.
Права
Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.
Ошибки
- ValueError при неверной сцене, цвете, геометрии или превышении пределов. TypeError/KeyError возможны для структурно неверного описания.
Пример
result = canvas.build()