Interface UmbTreeItemContext<TreeItemType>

interface UmbTreeItemContext<TreeItemType> {
    childItems: Observable<TreeItemType[]>;
    entityType?: string;
    hasActions: Observable<boolean>;
    hasChildren: Observable<boolean>;
    isActive: Observable<boolean>;
    isLoading: Observable<boolean>;
    isSelectable: Observable<boolean>;
    isSelectableContext: Observable<boolean>;
    isSelected: Observable<boolean>;
    pagination: UmbPaginationManager;
    path: Observable<string>;
    treeItem: Observable<undefined | TreeItemType>;
    unique?: null | string;
    constructPath(pathname: string, entityType: string, unique: string): string;
    deselect(): void;
    destroy(): void;
    loadChildren(): void;
    select(): void;
    setTreeItem(treeItem: undefined | TreeItemType): void;
    toggleContextMenu(): void;
}

Type Parameters

TreeItemType extends UmbTreeItemModel

Hierarchy (view full)

UmbApi
- UmbTreeItemContext

Implemented by

UmbTreeItemContextBase

Properties

childItems

childItems: Observable<TreeItemType[]>

`Optional`entityType

entityType?: string

hasActions

hasActions: Observable<boolean>

hasChildren

hasChildren: Observable<boolean>

isActive

isActive: Observable<boolean>

isLoading

isLoading: Observable<boolean>

isSelectable

isSelectable: Observable<boolean>

isSelectableContext

isSelectableContext: Observable<boolean>

isSelected

isSelected: Observable<boolean>

pagination

pagination: UmbPaginationManager

path

path: Observable<string>

treeItem

treeItem: Observable<undefined | TreeItemType>

`Optional`unique

unique?: null | string

Methods

constructPath

constructPath(pathname, entityType, unique): string
Parameters
- pathname: string
- entityType: string
- unique: string
Returns string
- Defined in src/packages/core/tree/tree-item/tree-item-context.interface.ts:25

deselect

deselect(): void
Returns void
- Defined in src/packages/core/tree/tree-item/tree-item-context.interface.ts:24

destroy

destroy(): void
Returns void
Inherited from UmbApi.destroy
- Defined in src/libs/extension-api/models/api.interface.ts:2

loadChildren

loadChildren(): void
Returns void
- Defined in src/packages/core/tree/tree-item/tree-item-context.interface.ts:21

select

select(): void
Returns void
- Defined in src/packages/core/tree/tree-item/tree-item-context.interface.ts:23

setTreeItem

setTreeItem(treeItem): void
Parameters
- treeItem: undefined | TreeItemType
Returns void
- Defined in src/packages/core/tree/tree-item/tree-item-context.interface.ts:20

toggleContextMenu

toggleContextMenu(): void
Returns void
- Defined in src/packages/core/tree/tree-item/tree-item-context.interface.ts:22