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

Type definitions for DocsVision WebClient scripts and extensions.

import { IControlDescription } from '@docsvision/webclient/System/IControlDescription';
import { EventHandlersMap } from '@docsvision/webclient/System/EventHandlersMap';
import { ILocalizationsMap } from "@docsvision/webclient/System/ILocalizationsMap";
import { IUrlCollection } from "@docsvision/webclient/System/IUrlCollection";
import { Service } from "@docsvision/web/core/services";
/** Интерфейс расширения Web-клиента. */
export interface IExtension extends Partial<IUrlCollection> {
    /** Уникальное название расширения, которое будет отображаться в окне About. */
    readonly name: string;
    /** Версия расширения в произвольном формате. */
    readonly version: string;
    /** Вызывается после инициализации приложения. */
    initialize?(): any;
    /** Служит для добавления локализаций в {@link resources} */
    getLocalizations?(): ILocalizationsMap;
    /** Контролы, поставляемые с расширением. */
    readonly controls?: IControlDescription[];
    /**
     * Обработчики событий.
     *
     * Пример использования:
     *
     */
    readonly globalEventHandlers?: EventHandlersMap[];
    /** Сервисы, используемые во всем приложении. */
    readonly globalServices?: Service[];
    /** Сервисы, имеющие особое поведение в рамках каждой конкретной разметки. */
    readonly layoutServices?: Service[];
}