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

    Interface UmbPickerTreeDataSource<TreeItemType, TreeRootType>

    Interface for a tree repository. UmbTreeRepository

    interface UmbPickerTreeDataSource<
        TreeItemType extends UmbTreeItemModel = UmbTreeItemModel,
        TreeRootType extends UmbTreeRootModel = UmbTreeRootModel,
    > {
        createTreeItemDataResolver?: (
            host: UmbControllerHost,
            args?: UmbCreateTreeItemDataResolverArgs,
        ) => UmbTreeItemDataResolver<TreeItemType> | undefined;
        items?: (
            uniques: string[],
        ) => Promise<Observable<UmbItemModel[]> | undefined>;
        requestItems: (
            uniques: string[],
        ) => Promise<
            UmbRepositoryResponseWithAsObservable<
                UmbItemModel[]
                | undefined,
                UmbItemModel[] | undefined,
            >,
        >;
        requestTreeItemAncestors: (
            args: UmbTreeAncestorsOfRequestArgs,
        ) => Promise<UmbRepositoryResponse<TreeItemType[]>>;
        requestTreeItemsOf: (
            args: UmbTreeChildrenOfRequestArgs,
        ) => Promise<
            UmbRepositoryResponseWithAsObservable<
                UmbTargetPagedModel<TreeItemType>,
                TreeItemType[],
            >,
        >;
        requestTreeRoot: () => Promise<UmbRepositoryResponse<TreeRootType>>;
        requestTreeRootItems: (
            args: UmbTreeRootItemsRequestArgs,
        ) => Promise<
            UmbRepositoryResponseWithAsObservable<
                UmbTargetPagedModel<TreeItemType>,
                TreeItemType[],
            >,
        >;
        requestTreeStartNode?: () => Promise<UmbTreeStartNode | undefined>;
        rootTreeItems?: () => Promise<Observable<TreeItemType[]>>;
        treeItemsOf?: (
            parentUnique: string | null,
        ) => Promise<Observable<TreeItemType[]>>;
        treePickableFilter?: (item: TreeItemType) => boolean;
        createItemDataResolver?(host: UmbControllerHost): UmbItemDataResolver;
        destroy(): void;
        getConfig?(): UmbConfigCollectionModel | undefined;
        setConfig?(config: UmbConfigCollectionModel | undefined): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    createTreeItemDataResolver? items? requestItems requestTreeItemAncestors requestTreeItemsOf requestTreeRoot requestTreeRootItems requestTreeStartNode? rootTreeItems? treeItemsOf? treePickableFilter?
    createItemDataResolver? destroy getConfig? setConfig?
    createTreeItemDataResolver?: (
        host: UmbControllerHost,
        args?: UmbCreateTreeItemDataResolverArgs,
    ) => UmbTreeItemDataResolver<TreeItemType> | undefined

    Creates an item data resolver for a tree item. Implement this to resolve names and icons that cannot be read directly off the tree item, such as variant aware document names.

    Type Declaration

    UmbTreeRepository

    items?: (uniques: string[]) => Promise<Observable<UmbItemModel[]> | undefined>
    requestItems: (
        uniques: string[],
    ) => Promise<
        UmbRepositoryResponseWithAsObservable<
            UmbItemModel[]
            | undefined,
            UmbItemModel[] | undefined,
        >,
    >
    requestTreeItemAncestors: (
        args: UmbTreeAncestorsOfRequestArgs,
    ) => Promise<UmbRepositoryResponse<TreeItemType[]>>

    Requests the ancestors of the given item.

    UmbTreeRepository

    requestTreeItemsOf: (
        args: UmbTreeChildrenOfRequestArgs,
    ) => Promise<
        UmbRepositoryResponseWithAsObservable<
            UmbTargetPagedModel<TreeItemType>,
            TreeItemType[],
        >,
    >

    Requests the children of the given parent item.

    UmbTreeRepository

    requestTreeRoot: () => Promise<UmbRepositoryResponse<TreeRootType>>

    Requests the root of the tree.

    UmbTreeRepository

    requestTreeRootItems: (
        args: UmbTreeRootItemsRequestArgs,
    ) => Promise<
        UmbRepositoryResponseWithAsObservable<
            UmbTargetPagedModel<TreeItemType>,
            TreeItemType[],
        >,
    >

    Requests the root items of the tree.

    UmbTreeRepository

    requestTreeStartNode?: () => Promise<UmbTreeStartNode | undefined>
    rootTreeItems?: () => Promise<Observable<TreeItemType[]>>

    Returns an observable of the root items of the tree.

    UmbTreeRepository

    Use requestTreeRootItems instead. It will be removed in Umbraco 18.

    treeItemsOf?: (
        parentUnique: string | null,
    ) => Promise<Observable<TreeItemType[]>>

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

    UmbTreeRepository

    Use requestTreeItemsOf instead. It will be removed in Umbraco 18.

    treePickableFilter?: (item: TreeItemType) => boolean

    Settings
    Member Visibility

    On This Page
    Properties
    Methods