Cluster · разработчикам
Element
Описание элемента страницы. Данные страницы хранятся отдельно от описания.
Все методы SDK · Типы и ошибки
Получение объекта
element = app.ui.element("status", "text", "Status")__init__
Создаёт Element. Обычный способ получения объекта показан выше; прямой конструктор не выполняет сетевые запросы.
def __init__(id: str, kind: str, label: str | dict[str, str] | None = None, **data: JSON) -> None: ...Аргументы
id: str, обязательный. Идентификатор объекта, полученный при его создании. Не путь сервера.kind: str, обязательный. Тип text, metric, table, button, form или tasks.label: str | dict[str, str] | None, по умолчаниюNone. Подпись либо словарь локализаций, например ru и en.data: JSON, произвольные именованные аргументы. Допустимые именованные параметры: параметры элемента по типу, см. MODULES.md. Точные типы и исходные значения низкоуровневых операций приведены в разделе типов и ROUTES.md.
Результат
None. Создаёт Element. Обычный способ получения объекта показан выше; прямой конструктор не выполняет сетевые запросы.
Права
Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.
Ошибки
ValueError('Invalid element type'): условие проверяется до продолжения операции.
Пример
# Обычный способ получения объекта:
element = app.ui.element("status", "text", "Status")label
Меняет подпись элемента в локальном описании.
def label(value: str | dict[str, str]) -> Self: ...Аргументы
value: str | dict[str, str], обязательный. Подпись либо словарь локализаций ru/en.
Результат
Self. Тот же объект после успешной операции. Меняет подпись элемента в локальном описании.
Права
Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.
Ошибки
- Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.
Пример
result = element.label("Title")build
Возвращает глубокую JSON-копию описания элемента.
def build() -> ElementDefinition: ...Аргументы
Нет.
Результат
ElementDefinition. Возвращает глубокую JSON-копию описания элемента.
Права
Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.
Ошибки
- Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.
Пример
result = element.build()