@docsvision/webclient/System/ILayoutContainer.d.ts

Type definitions for DocsVision WebClient scripts and extensions.

import { GenModels } from "@docsvision/webclient/Generated/DocsVision.WebClient.Models";
import { ILayout } from "@docsvision/webclient/System/$Layout";
export interface ILayoutContainer<T extends GenModels.LayoutViewModel> {
    /**
     * Возвращает разметку карточки.
     */
    layout: ILayout;
    /**
     * Скрывать ли диалог подтверждения действия пользователя при изменении маршрута
     */
    pageLeaveConfirmationDisabled: boolean;
    /**
     * Возвращает родительский контейнер, в котором находится текущий контейнер
     */
    readonly parent: ILayoutContainer<GenModels.LayoutViewModel>;
    /**
     * Возвращает наименование позиции разметки
     */
    readonly positionName: string;
    /**
     * Возвращает наименование разметки
     */
    readonly name: string;
    /**
     * Возвращает наименования дочерних разметок
     */
    children: ILayoutContainer<GenModels.LayoutViewModel>[];
    /**
     * Возвращает идентификатор корневого элемента, в котором расположена разметка.
     */
    readonly rootElementId: string;
    /**
     * Возвращает корневой элемент, в котором расположена разметка.
     */
    readonly rootElement: HTMLElement;
    /**
     *  Модель разметки, поступившая с сервера Web-клиента.
     */
    readonly layoutViewModel: T;
    /**
     * Перезагрузка разметки с данными, переданными в параметре layoutViewModel
     */
    reload(layoutViewModel: T): Promise<void>;
    /**
     * Уничтожение разметки.
     */
    destroy(): Promise<any>;
}