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

    Class UmbDefaultTreeContext<TreeItemType, TreeRootType, RequestArgsType>

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index
    activeManager: UmbTreeItemActiveManager = ...
    additionalRequestArgs: Observable<object | Partial<RequestArgsType>> = ...
    currentPageItems: Observable<TreeItemType[]> = ...
    drillable: Observable<boolean> = ...

    Whether opening an item takes the user into it. A property of the host, so it is the same for every item in the tree.

    Off unless the host declares otherwise: a tree that can do no more than expand and collapse is the common case, and the one where offering to drill into an item would strand everything below it.

    expandTreeRoot: Observable<boolean | undefined> = ...
    expansion: UmbTreeExpansionManager = ...
    filter?: (item: TreeItemType) => boolean = ...
    foldersOnly: Observable<boolean> = ...
    hasChildren: Observable<boolean> = ...
    hideTreeItemActions: Observable<boolean> = ...
    hideTreeRoot: Observable<boolean> = ...
    interactionMemory: UmbInteractionMemoryManager = ...
    isLoading: Observable<boolean> = ...
    isLoadingNextChildren: Observable<boolean> = ...
    isLoadingPrevChildren: Observable<boolean> = ...
    isMenu: Observable<boolean | undefined> = ...
    loadTree: UmbDebouncedFunction<() => Promise<void>> = ...

    Loads the tree

    UmbDefaultTreeContext

    pagination: UmbPaginationManager = ...
    reloadTree: UmbDebouncedFunction<() => Promise<void>> = ...

    Reloads the tree in its current expansion state

    UmbDefaultTreeContext

    rootItems: Observable<TreeItemType[]> = ...
    selectableFilter?: (item: TreeItemType) => boolean = ...
    selection: UmbSelectionManager<string | null> = ...
    selectOnly: Observable<boolean | undefined> = ...
    startNode: Observable<UmbTreeStartNode | undefined> = ...
    treeRoot: Observable<TreeRootType | undefined> = ...
    view: UmbTreeViewManager = ...
    • 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: EventListenerOrEventListenerObject | null
      • 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. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • Returns whether opening an item takes the user into it.

      Returns boolean

      True when the host acts on UmbTreeItemOpenEvent.

      UmbDefaultTreeContext

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject | null
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Sets whether opening an item takes the user into it.

      Parameters

      • value: boolean

        True when the host acts on UmbTreeItemOpenEvent.

      Returns void

      UmbDefaultTreeContext

    • Sets the expandTreeRoot config

      Parameters

      • expandTreeRoot: boolean

        Whether to expand the tree root

      Returns void

      UmbDefaultTreeContext

    • Sets the expansion state

      Parameters

      • data: UmbTreeExpansionModel

        The expansion state

      Returns void

      UmbDefaultTreeContext

    • Sets the foldersOnly config

      Parameters

      • foldersOnly: boolean

        Whether to show only folders

      Returns void

      UmbDefaultTreeContext

    • Sets the hideTreeRoot config

      Parameters

      • hideTreeRoot: boolean

        Whether to hide the tree root

      Returns void

      UmbDefaultTreeContext