Cluster · разработчикам
Group
Слой, который одновременно является контейнером дочерних слоёв. Геометрия группы хранится в её описании.
Все методы SDK · Типы и ошибки
Получение объекта
canvas = app.images.canvas(800, 400)
group = canvas.group("card", 20, 20, 400, 200)Наследует Layer. Унаследованные методы: id, at, move, resize, opacity, rotate, show, hide, fill, stroke, value, align, front, back, copy.
Наследует Container. Унаследованные методы: add, layer, rect, ellipse, gradient, text, image, group, points, line, polygon, get, order, grid, row, column.
__init__
Создаёт Group. Обычный способ получения объекта показан выше; прямой конструктор не выполняет сетевые запросы.
def __init__(parent: Container, data: LayerData) -> None: ...Аргументы
parent: Container, обязательный. Родительский контейнер слоя. Обычно слой создаётся методом контейнера.data: LayerData, обязательный. Описание слоя: id, kind, x, y, width, height и свойства его вида. Для group также layers; полная форма в IMAGE_GENERATOR.md.
Результат
None. Создаёт Group. Обычный способ получения объекта показан выше; прямой конструктор не выполняет сетевые запросы.
Права
Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.
Ошибки
- Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.
Пример
# Обычный способ получения объекта:
canvas = app.images.canvas(800, 400)
group = canvas.group("card", 20, 20, 400, 200)width
Читает или меняет ширину группы в её локальном описании.
def width() -> float: ...Свойство: читается без скобок и без await. Поддерживает присваивание.
Аргументы
Нет.
Результат
float. Читает или меняет ширину группы в её локальном описании.
Права
Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.
Ошибки
- Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.
Пример
value = group.widthheight
Читает или меняет высоту группы в её локальном описании.
def height() -> float: ...Свойство: читается без скобок и без await. Поддерживает присваивание.
Аргументы
Нет.
Результат
float. Читает или меняет высоту группы в её локальном описании.
Права
Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.
Ошибки
- Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.
Пример
value = group.heightremove
Без аргументов удаляет саму группу из родителя; с ID удаляет её дочерние слои и возвращает группу.
def remove(*ids: str) -> Group | Container: ...Аргументы
ids: str, позиционные значения. Позиционные ID слоёв. Для order требуется каждый прямой дочерний ID ровно один раз.
Результат
Group | Container. Без аргументов удаляет саму группу из родителя; с ID удаляет её дочерние слои и возвращает группу.
Права
Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.
Ошибки
- Для унаследованных операций действуют ошибки Layer и Container; полная проверка размеров выполняется при Canvas.build().
Пример
result = group.remove("background")set
Меняет свойства группы, запрещая прямую замену структурных полей id, kind и layers.
def set(**values: JSON) -> Self: ...Аргументы
values: JSON, произвольные именованные аргументы. Именованные свойства слоя из перечня в IMAGE_GENERATOR.md. id, kind и layers запрещены.
Результат
Self. Тот же объект после успешной операции. Меняет свойства группы, запрещая прямую замену структурных полей id, kind и layers.
Права
Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.
Ошибки
- Для унаследованных операций действуют ошибки Layer и Container; полная проверка размеров выполняется при Canvas.build().
Пример
result = group.set(opacity=0.8)