@umbraco-cms/backoffice
    Preparing search index...

    Interface UmbTreeStore<TreeItemType>

    Interface for a tree store. UmbTreeStore

    interface UmbTreeStore<TreeItemType extends UmbTreeItemModelBase> {
        _host: UmbControllerHost;
        all: () => Observable<TreeItemType[]>;
        append: (item: TreeItemType) => void;
        appendItems: (items: TreeItemType[]) => void;
        childrenOf: (parentUnique: null | string) => Observable<TreeItemType[]>;
        getItems: (uniques: string[]) => TreeItemType[];
        removeItem: (unique: string) => void;
        removeItems: (uniques: string[]) => void;
        rootItems: Observable<TreeItemType[]>;
        updateItem: (unique: string, item: Partial<T>) => void;
        get controllerAlias(): UmbControllerAlias;
        addEventListener(
            type: string,
            callback: null | EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addUmbController(controller: UmbController): void;
        consumeContext<
            BaseType extends UmbContextMinimal = UmbContextMinimal,
            ResultType extends UmbContextMinimal = BaseType,
        >(
            alias: string | UmbContextToken<BaseType, ResultType>,
            callback: UmbContextCallback<ResultType>,
        ): UmbContextConsumerController<BaseType, ResultType>;
        destroy(): void;
        dispatchEvent(event: Event): boolean;
        getContext<
            BaseType extends UmbContextMinimal = UmbContextMinimal,
            ResultType extends UmbContextMinimal = BaseType,
        >(
            alias: string | UmbContextToken<BaseType, ResultType>,
            options?: UmbClassGetContextOptions,
        ): Promise<undefined | ResultType>;
        getHostElement(): Element;
        getUmbControllers(
            filterMethod: (ctrl: UmbController) => boolean,
        ): UmbController[];
        hasUmbController(controller: UmbController): boolean;
        hostConnected(): void;
        hostDisconnected(): void;
        observe<
            ObservableType extends undefined
            | Observable<T>,
            T,
            SpecificT = ObservableType extends Observable<U>
                ? ObservableType<ObservableType> extends undefined ? undefined | U : U
                : undefined,
            SpecificR = ObservableType extends undefined
                ? undefined
                | UmbObserverController<SpecificT>
                : UmbObserverController<SpecificT>,
        >(
            source: ObservableType,
            callback?: ObserverCallback<SpecificT>,
            controllerAlias?: null | UmbControllerAlias,
        ): SpecificR;
        provideContext<R extends UmbContextMinimal = UmbContextMinimal>(
            alias: string | UmbContextToken<R, R>,
            instance: R,
        ): UmbContextProviderController<R>;
        removeEventListener(
            type: string,
            callback: null | EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        removeUmbController(controller: UmbController): void;
        removeUmbControllerByAlias(unique: UmbControllerAlias): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    _host all append appendItems childrenOf getItems removeItem removeItems rootItems updateItem

    Accessors

    controllerAlias

    Methods

    addEventListener addUmbController consumeContext destroy dispatchEvent getContext getHostElement getUmbControllers hasUmbController hostConnected hostDisconnected observe provideContext removeEventListener removeUmbController removeUmbControllerByAlias

    Properties

    _host

    _host: UmbControllerHost
    all: () => Observable<TreeItemType[]>
    append: (item: TreeItemType) => void
    appendItems: (items: TreeItemType[]) => void
    childrenOf: (parentUnique: null | string) => Observable<TreeItemType[]>

    Returns an observable of the children of the given parent item.

    UmbTreeStore

    getItems: (uniques: string[]) => TreeItemType[]
    removeItem: (unique: string) => void
    removeItems: (uniques: string[]) => void
    rootItems: Observable<TreeItemType[]>

    Returns an observable of the root items of the tree.

    UmbTreeStore

    updateItem: (unique: string, item: Partial<T>) => void

    Accessors

    Methods

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods