TESSA Web API
    Preparing search index...

    Interface IViewModelBase

    Базовая вью модель.

    interface IViewModelBase {
        alias: null | string;
        disposeList: DisposeList;
        info: null | IStorage;
        isMounted: boolean;
        isReady: boolean;
        onContextResolved: EventHandler<UIContext, IViewModelBase>;
        onReady: EventHandler<EmptyEvent, IViewModelBase>;
        uiId: number;
        dispose(): void;
        mount(
            params?: {
                actionsRef?: ViewModelBaseComponentRef<unknown>;
                context?: UIContext;
                ref?: ViewModelBaseComponentRef<unknown>;
            },
        ): void;
        tryGetComponentActionsRef<T = object>(): null | T;
        tryGetComponentRef<T = Element>(): null | T;
        unmount(): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    alias disposeList info isMounted isReady onContextResolved onReady uiId

    Methods

    dispose mount tryGetComponentActionsRef tryGetComponentRef unmount

    Properties

    alias: null | string

    Псевдоним модели представления.

    disposeList: DisposeList

    Функции, которые будут вызваны в конце жизненного цикла вью модели. Может использоваться для очистки связанных объектов, если их жизненный цикл совпадает с жизненным циклом вью модели.

    vm.disposeList.add(reaction(
      () => vm.isMounted,
      v => console.log(`vm.isMounted = ${v}`)
    ));
    info: null | IStorage

    Хранилище любой дополнительной информации вью модели.

    isMounted: boolean

    Флаг указывающий на то, что вью компонент смонтирован.

    isReady: boolean

    Флаг указывающий на то, что вью модель готова к работе.

    onContextResolved: EventHandler<UIContext, IViewModelBase>

    Событие вызывается когда UI контекст был получен вью моделью.

    onReady: EventHandler<EmptyEvent, IViewModelBase>

    Событие вызывается когда вью модель готова к использованию. Событие может вызываться несколько раз за время жизни вью модели. Обработчик может вернуть функцию очистки, которая будет вызвана, когда вью модель перестанет считаться готовой к работе, т.е. компонент размонтирован или вызван dispose вью модели.

    vm.onReady.add(() => {
     console.log('ready');
     return () => console.log('unready');
    });
    uiId: number

    Уникальный идентификатор UI элемента.

    Methods

    • Returns void

    • Метод вызывается при монтировании вью компонента и может передавать ссылку на сам компонент.

      Parameters

      Returns void

    • Ссылка на императивные методы вью компонента.

      Type Parameters

      • T = object

      Returns null | T

    • Ссылка на вью компонент.

      Type Parameters

      • T = Element

      Returns null | T

    • Метод вызывается при размонтировании вью компонента.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods