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

    Interface UmbDocumentTreeStore

    UmbDocumentTreeStore

    • Tree Data Store for Document Items
    • Use UmbDocumentTreeRepository instead. This will be removed in Umbraco 18.
    interface UmbDocumentTreeStore {
        _data: UmbArrayState<UmbTreeItemModel>;
        _host: UmbControllerHost;
        rootItems: Observable<UmbTreeItemModel[]>;
        get controllerAlias(): UmbControllerAlias;
        addEventListener(
            type: string,
            callback: null | EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addUmbController(controller: UmbController): void;
        all(): Observable<UmbTreeItemModel[]>;
        append(item: UmbTreeItemModel): void;
        appendItems(items: UmbTreeItemModel[]): void;
        childrenOf(parentUnique: null | string): Observable<UmbTreeItemModel[]>;
        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;
        getItems(uniques: string[]): UmbTreeItemModel[];
        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;
        removeItem(unique: string): void;
        removeItems(uniques: string[]): void;
        removeUmbController(controller: UmbController): void;
        removeUmbControllerByAlias(unique: UmbControllerAlias): void;
        updateItem(unique: string, data: Partial<StoreItemType>): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _data _host rootItems

    Accessors

    controllerAlias

    Methods

    addEventListener addUmbController all append appendItems childrenOf consumeContext destroy dispatchEvent getContext getHostElement getItems getUmbControllers hasUmbController hostConnected hostDisconnected observe provideContext removeEventListener removeItem removeItems removeUmbController removeUmbControllerByAlias updateItem

    Properties

    Protected_data

    _data: UmbArrayState<UmbTreeItemModel>

    _host

    _host: UmbControllerHost
    rootItems: Observable<UmbTreeItemModel[]> = ...

    An observable to observe the root items

    UmbUniqueTreeStore

    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