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

    Interface UmbTreeItemApi<TreeItemType, ManifestType>

    The base tree item contract — shared by full tree item contexts and card apis — covering item data, selection, active state, path, and entity actions. Children, expansion, and pagination are not included here; they extend this contract in UmbTreeItemContext.

    interface UmbTreeItemApi<
        TreeItemType extends UmbTreeItemModel = UmbTreeItemModel,
        ManifestType extends ManifestBase = ManifestBase,
    > {
        entityType?: string;
        hasActions: Observable<boolean>;
        hasChildren: Observable<boolean>;
        isActive: Observable<boolean>;
        isSelectable: Observable<boolean>;
        isSelectableContext: Observable<boolean>;
        isSelected: Observable<boolean>;
        manifest: ManifestType | undefined;
        noAccess: Observable<boolean>;
        path: Observable<string>;
        selectOnly: Observable<boolean>;
        treeItem: Observable<TreeItemType | undefined>;
        unique?: UmbEntityUnique;
        constructPath(
            pathname: string,
            entityType: string,
            unique: string | null,
        ): string;
        deselect(): void;
        destroy(): void;
        getHostElement(): Element;
        getTreeItem(): TreeItemType | undefined;
        open(): void;
        select(): void;
        setTreeItem(item: TreeItemType | undefined): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    entityType? hasActions hasChildren isActive isSelectable isSelectableContext isSelected manifest noAccess path selectOnly treeItem unique?

    Methods

    constructPath deselect destroy getHostElement getTreeItem open select setTreeItem

    Properties

    entityType?: string
    hasActions: Observable<boolean>
    hasChildren: Observable<boolean>
    isActive: Observable<boolean>
    isSelectable: Observable<boolean>
    isSelectableContext: Observable<boolean>
    isSelected: Observable<boolean>
    manifest: ManifestType | undefined
    noAccess: Observable<boolean>
    path: Observable<string>
    selectOnly: Observable<boolean>
    treeItem: Observable<TreeItemType | undefined>
    unique?: UmbEntityUnique

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods