Interface UmbTreeDataSource<TreeItemType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>

Interface for a tree data source. UmbTreeDataSource

interface UmbTreeDataSource<
    TreeItemType extends UmbTreeItemModel,
    TreeRootItemsRequestArgsType extends
        UmbTreeRootItemsRequestArgs = UmbTreeRootItemsRequestArgs,
    TreeChildrenOfRequestArgsType extends
        UmbTreeChildrenOfRequestArgs = UmbTreeChildrenOfRequestArgs,
    TreeAncestorsOfRequestArgsType extends
        UmbTreeAncestorsOfRequestArgs = UmbTreeAncestorsOfRequestArgs,
> {
    getAncestorsOf(
        args: TreeAncestorsOfRequestArgsType,
    ): Promise<UmbDataSourceResponse<TreeItemType[]>>;
    getChildrenOf(
        args: TreeChildrenOfRequestArgsType,
    ): Promise<UmbDataSourceResponse<UmbTargetPagedModel<TreeItemType>>>;
    getRootItems(
        args: TreeRootItemsRequestArgsType,
    ): Promise<UmbDataSourceResponse<UmbTargetPagedModel<TreeItemType>>>;
}

Type Parameters

TreeItemType extends UmbTreeItemModel
TreeRootItemsRequestArgsType extends UmbTreeRootItemsRequestArgs = UmbTreeRootItemsRequestArgs
TreeChildrenOfRequestArgsType extends UmbTreeChildrenOfRequestArgs = UmbTreeChildrenOfRequestArgs
TreeAncestorsOfRequestArgsType extends UmbTreeAncestorsOfRequestArgs = UmbTreeAncestorsOfRequestArgs

Implemented by

UmbTreeServerDataSourceBase

Index

Methods

getAncestorsOf getChildrenOf getRootItems

Methods

getAncestorsOf

getAncestorsOf(
args: TreeAncestorsOfRequestArgsType,
): Promise<UmbDataSourceResponse<TreeItemType[]>>
Gets the ancestors of the given item.
Parameters
- args: TreeAncestorsOfRequestArgsType
Returns Promise<UmbDataSourceResponse<TreeItemType[]>>

Memberof
UmbTreeDataSource
- Defined in src/packages/core/tree/data/tree-data-source.interface.ts:49

getChildrenOf

getChildrenOf(
args: TreeChildrenOfRequestArgsType,
): Promise<UmbDataSourceResponse<UmbTargetPagedModel<TreeItemType>>>
Gets the children of the given parent item.
Parameters
- args: TreeChildrenOfRequestArgsType
Returns Promise<UmbDataSourceResponse<UmbTargetPagedModel<TreeItemType>>>

Memberof
UmbTreeDataSource
- Defined in src/packages/core/tree/data/tree-data-source.interface.ts:42

getRootItems

getRootItems(
args: TreeRootItemsRequestArgsType,
): Promise<UmbDataSourceResponse<UmbTargetPagedModel<TreeItemType>>>
Gets the root items of the tree.
Parameters
- args: TreeRootItemsRequestArgsType
Returns Promise<UmbDataSourceResponse<UmbTargetPagedModel<TreeItemType>>>
The root items of the tree.

Memberof
UmbTreeDataSource
- Defined in src/packages/core/tree/data/tree-data-source.interface.ts:35