Class UmbDefaultTreeContext<TreeItemType, TreeRootType, RequestArgsType>

This base provides the necessary for a class to become a context-api controller.

Type Parameters

TreeItemType extends UmbTreeItemModel
TreeRootType extends UmbTreeRootModel
RequestArgsType extends UmbTreeRootItemsRequestArgs = UmbTreeRootItemsRequestArgs

Hierarchy (View Summary)

UmbContextBase
- UmbDefaultTreeContext

Implements

UmbTreeContext

Constructors

constructor

new UmbDefaultTreeContext<
    TreeItemType extends UmbTreeItemModel,
    TreeRootType extends UmbTreeRootModel,
    RequestArgsType extends
        UmbTreeRootItemsRequestArgs = UmbTreeRootItemsRequestArgs,
>(
    host: UmbControllerHost,
): UmbDefaultTreeContext<TreeItemType, TreeRootType, RequestArgsType>
Type Parameters
- TreeItemType extends UmbTreeItemModel
- TreeRootType extends UmbTreeRootModel
- RequestArgsType extends UmbTreeRootItemsRequestArgs = UmbTreeRootItemsRequestArgs
Parameters
- host: UmbControllerHost
Returns UmbDefaultTreeContext<TreeItemType, TreeRootType, RequestArgsType>
Overrides UmbContextBase.constructor
- Defined in src/packages/core/tree/default/default-tree.context.ts:77

Properties

_host

_host: UmbControllerHost

`Readonly`additionalRequestArgs

additionalRequestArgs: Observable<object | Partial<RequestArgsType>> = ...

expandTreeRoot

expandTreeRoot: Observable<undefined | boolean> = ...

`Readonly`expansion

expansion: UmbTreeExpansionManager = ...

`Optional`filter

filter?: (item: TreeItemType) => boolean = ...

foldersOnly

foldersOnly: Observable<boolean> = ...

hideTreeRoot

hideTreeRoot: Observable<boolean> = ...

loadTree

loadTree: (this: any, ...args: any[]) => void = ...

Loads the tree

Memberof

UmbDefaultTreeContext

`Readonly`pagination

pagination: UmbPaginationManager = ...

rootItems

rootItems: Observable<TreeItemType[]> = ...

`Optional`selectableFilter

selectableFilter?: (item: TreeItemType) => boolean = ...

`Readonly`selection

selection: UmbSelectionManager<null | string> = ...

startNode

startNode: Observable<undefined | UmbTreeStartNode> = ...

treeRoot

treeRoot: Observable<undefined | TreeRootType> = ...

Accessors

controllerAlias

get controllerAlias(): UmbControllerAlias
Returns UmbControllerAlias
Implementation of UmbTreeContext.controllerAlias
Inherited from UmbContextBase.controllerAlias
- Defined in src/libs/controller-api/controller.interface.ts:3

manifest

get manifest(): undefined | ManifestTree
Returns undefined | ManifestTree
- Defined in src/packages/core/tree/default/default-tree.context.ts:110
set manifest(manifest: undefined | ManifestTree): void
Sets the manifest
Parameters
- manifest: undefined | ManifestTree
Returns void
Memberof
UmbDefaultTreeContext
- Defined in src/packages/core/tree/default/default-tree.context.ts:105

Methods

addEventListener

addEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
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: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Implementation of UmbTreeContext.addEventListener
Inherited from UmbContextBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Implementation of UmbTreeContext.addUmbController
Inherited from UmbContextBase.addUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:6

consumeContext

consumeContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    callback: UmbContextCallback<ResultType>,
): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- callback: UmbContextCallback<ResultType>
  Callback method called when context is resolved.
Returns UmbContextConsumerController<BaseType, ResultType>
Reference to the created Context Consumer Controller instance

Description
Setup a subscription for a context. The callback is called when the context is resolved.

Memberof
UmbClassInterface
Implementation of UmbTreeContext.consumeContext
Inherited from UmbContextBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

destroy

destroy(): void
Returns void
Implementation of UmbTreeContext.destroy
Overrides UmbContextBase.destroy
- Defined in src/packages/core/tree/default/default-tree.context.ts:399

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Implementation of UmbTreeContext.dispatchEvent
Inherited from UmbContextBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

getAdditionalRequestArgs

getAdditionalRequestArgs(): object | Partial<RequestArgsType>
Returns object | Partial<RequestArgsType>
- Defined in src/packages/core/tree/default/default-tree.context.ts:290

getContext

getContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    options?: UmbClassGetContextOptions,
): Promise<undefined | ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- Optionaloptions: UmbClassGetContextOptions
Returns Promise<undefined | ResultType>
A Promise with the reference to the Context Api Instance

Description
Retrieve a context. Notice this is a one time retrieving of a context, meaning if you expect this to be up to date with reality you should instead use the consumeContext method.

Memberof
UmbClassInterface
Implementation of UmbTreeContext.getContext
Inherited from UmbContextBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getExpandTreeRoot

getExpandTreeRoot(): undefined | boolean
Gets the expandTreeRoot config

Returns undefined | boolean
- Whether to expand the tree root
Memberof
UmbDefaultTreeContext
- Defined in src/packages/core/tree/default/default-tree.context.ts:328

getExpansion

getExpansion(): UmbTreeExpansionModel
Gets the expansion state

Returns UmbTreeExpansionModel
- The expansion state
Memberof
UmbDefaultTreeContext
- Defined in src/packages/core/tree/default/default-tree.context.ts:309

getFoldersOnly

getFoldersOnly(): boolean
Gets the foldersOnly config

Returns boolean
- Whether to show only folders
Memberof
UmbDefaultTreeContext
- Defined in src/packages/core/tree/default/default-tree.context.ts:276

getHideTreeRoot

getHideTreeRoot(): boolean
Gets the hideTreeRoot config

Returns boolean
Memberof
UmbDefaultTreeContext
- Defined in src/packages/core/tree/default/default-tree.context.ts:234

getHostElement

getHostElement(): Element
Returns Element
Implementation of UmbTreeContext.getHostElement
Inherited from UmbContextBase.getHostElement
- Defined in src/libs/controller-api/controller-host.interface.ts:9

getManifest

getManifest(): undefined | ManifestTree
Returns the manifest.

Returns undefined | ManifestTree
Memberof
UmbDefaultTreeContext

Deprecated
Use the .manifest property instead.
- Defined in src/packages/core/tree/default/default-tree.context.ts:120

getRepository

getRepository(): | undefined
| UmbTreeRepository<
    TreeItemType,
    TreeRootType,
    UmbTreeRootItemsRequestArgs,
    UmbTreeChildrenOfRequestArgs,
    UmbTreeAncestorsOfRequestArgs,
>
Returns
    | undefined
    | UmbTreeRepository<
        TreeItemType,
        TreeRootType,
        UmbTreeRootItemsRequestArgs,
        UmbTreeChildrenOfRequestArgs,
        UmbTreeAncestorsOfRequestArgs,
    >
- Defined in src/packages/core/tree/default/default-tree.context.ts:129

getStartNode

getStartNode(): undefined | UmbTreeStartNode
Gets the startNode config

Returns undefined | UmbTreeStartNode
- The start node
Memberof
UmbDefaultTreeContext
- Defined in src/packages/core/tree/default/default-tree.context.ts:255

getUmbControllers

getUmbControllers(
filterMethod: (ctrl: UmbController) => boolean,
): UmbController[]
Parameters
- filterMethod: (ctrl: UmbController) => boolean
Returns UmbController[]
Implementation of UmbTreeContext.getUmbControllers
Inherited from UmbContextBase.getUmbControllers
- Defined in src/libs/controller-api/controller-host.interface.ts:5

hasUmbController

hasUmbController(controller: UmbController): boolean
Parameters
- controller: UmbController
Returns boolean
Implementation of UmbTreeContext.hasUmbController
Inherited from UmbContextBase.hasUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:4

hostConnected

hostConnected(): void
Returns void
Implementation of UmbTreeContext.hostConnected
Inherited from UmbContextBase.hostConnected
- Defined in src/libs/controller-api/controller.interface.ts:4

hostDisconnected

hostDisconnected(): void
Returns void
Implementation of UmbTreeContext.hostDisconnected
Inherited from UmbContextBase.hostDisconnected
- Defined in src/libs/controller-api/controller.interface.ts:5

loadMore

loadMore(): void
Reloads the tree

Returns void
Memberof
UmbDefaultTreeContext
- Defined in src/packages/core/tree/default/default-tree.context.ts:146

observe

observe<
    ObservableType extends undefined
    | Observable<T>,
    T,
    SpecificT = ObservableType extends Observable<U>
        ? ObservableType<ObservableType> extends undefined ? undefined | U : U
        : undefined,
    SpecificR = ObservableType extends undefined
        ? undefined
        | UmbObserverController<SpecificT>
        : UmbObserverController<SpecificT>,
>(
    source: ObservableType,
    callback?: ObserverCallback<SpecificT>,
    controllerAlias?: null | UmbControllerAlias,
): SpecificR
Type Parameters
- ObservableType extends undefined | Observable<T>
- T
- SpecificT = ObservableType extends Observable<U>
  ? ObservableType<ObservableType> extends undefined ? undefined | U : U
  : undefined
- SpecificR = ObservableType extends undefined
      ? undefined
      | UmbObserverController<SpecificT>
      : UmbObserverController<SpecificT>
Parameters
- source: ObservableType
  An Observable to observe from.
- Optionalcallback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: null | UmbControllerAlias
  Define an explicit controller alias. If not defined then one will be generated based on the callback function. If null is parsed no controller alias will be given.
Returns SpecificR
Reference to the created Observer Controller instance.

Description
Observe an Observable. An Observable is a declared source of data that can be observed. An observables is declared from a UmbState.

Memberof
UmbClassInterface
Implementation of UmbTreeContext.observe
Inherited from UmbContextBase.observe
- Defined in src/libs/class-api/class.interface.ts:27

provideContext

provideContext<R extends UmbContextMinimal = UmbContextMinimal>(
alias: string | UmbContextToken<R, R>,
instance: R,
): UmbContextProviderController<R>
Type Parameters
- R extends UmbContextMinimal = UmbContextMinimal
Parameters
- alias: string | UmbContextToken<R, R>
- instance: R
  The API instance to be exposed.
Returns UmbContextProviderController<R>
Reference to the created Context Provider Controller instance

Description
Provide a context API for this or child elements.

Memberof
UmbClassInterface
Implementation of UmbTreeContext.provideContext
Inherited from UmbContextBase.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Implementation of UmbTreeContext.removeEventListener
Inherited from UmbContextBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

removeUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Implementation of UmbTreeContext.removeUmbController
Inherited from UmbContextBase.removeUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:8

removeUmbControllerByAlias

removeUmbControllerByAlias(unique: UmbControllerAlias): void
Parameters
- unique: UmbControllerAlias
Returns void
Implementation of UmbTreeContext.removeUmbControllerByAlias
Inherited from UmbContextBase.removeUmbControllerByAlias
- Defined in src/libs/controller-api/controller-host.interface.ts:7

setExpandTreeRoot

setExpandTreeRoot(expandTreeRoot: boolean): void
Sets the expandTreeRoot config
Parameters
- expandTreeRoot: boolean
  Whether to expand the tree root
Returns void
Memberof
UmbDefaultTreeContext
- Defined in src/packages/core/tree/default/default-tree.context.ts:318

setExpansion

setExpansion(data: UmbTreeExpansionModel): void
Sets the expansion state
Parameters
- data: UmbTreeExpansionModel
  The expansion state
Returns void
Memberof
UmbDefaultTreeContext
- Defined in src/packages/core/tree/default/default-tree.context.ts:300

setFoldersOnly

setFoldersOnly(foldersOnly: boolean): void
Sets the foldersOnly config
Parameters
- foldersOnly: boolean
  Whether to show only folders
Returns void
Memberof
UmbDefaultTreeContext
- Defined in src/packages/core/tree/default/default-tree.context.ts:264

setHideTreeRoot

setHideTreeRoot(hideTreeRoot: boolean): void
Sets the hideTreeRoot config
Parameters
- hideTreeRoot: boolean
  Whether to hide the tree root
Returns void
Memberof
UmbDefaultTreeContext
- Defined in src/packages/core/tree/default/default-tree.context.ts:222

setStartNode

setStartNode(startNode: undefined | UmbTreeStartNode): void
Sets the startNode config
Parameters
- startNode: undefined | UmbTreeStartNode
Returns void
Memberof
UmbDefaultTreeContext
- Defined in src/packages/core/tree/default/default-tree.context.ts:243

updateAdditionalRequestArgs

updateAdditionalRequestArgs(args: Partial<RequestArgsType>): void
Updates the requestArgs config and reloads the tree.
Parameters
- args: Partial<RequestArgsType>
Returns void
- Defined in src/packages/core/tree/default/default-tree.context.ts:284

Class UmbDefaultTreeContext<TreeItemType, TreeRootType, RequestArgsType>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbDefaultTreeContext<TreeItemType, TreeRootType, RequestArgsType>

Properties

_host

ReadonlyadditionalRequestArgs

expandTreeRoot

Readonlyexpansion

Optionalfilter

foldersOnly

hideTreeRoot

loadTree

Memberof

Readonlypagination

rootItems

OptionalselectableFilter

Readonlyselection

startNode

treeRoot

Accessors

controllerAlias

Returns UmbControllerAlias

manifest

Returns undefined | ManifestTree

Parameters

Returns void

Memberof

Methods

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

getAdditionalRequestArgs

Returns object | Partial<RequestArgsType>

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getExpandTreeRoot

Returns undefined | boolean

Memberof

getExpansion

Returns UmbTreeExpansionModel

Memberof

getFoldersOnly

Returns boolean

Memberof

getHideTreeRoot

Returns boolean

Memberof

getHostElement

Returns Element

getManifest

Returns undefined | ManifestTree

`Readonly`additionalRequestArgs

`Readonly`expansion

`Optional`filter

`Readonly`pagination

`Optional`selectableFilter

`Readonly`selection

Returns
| undefined
| UmbTreeRepository<
TreeItemType,
TreeRootType,
UmbTreeRootItemsRequestArgs,
UmbTreeChildrenOfRequestArgs,
UmbTreeAncestorsOfRequestArgs,
>