Class UmbTreeRepositoryBase<TreeItemType, TreeRootType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>`Abstract`

Base class for a tree repository.

Abstract

UmbTreeRepositoryBase

Implements

Type Parameters

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

Hierarchy (view full)

UmbRepositoryBase
- UmbTreeRepositoryBase

Implements

Constructors

constructor

new UmbTreeRepositoryBase<TreeItemType, TreeRootType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>(host, treeSourceConstructor, treeStoreContextAlias): UmbTreeRepositoryBase<TreeItemType, TreeRootType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>
Creates an instance of UmbTreeRepositoryBase.
Type Parameters
- TreeItemType extends UmbTreeItemModel
- TreeRootType extends UmbTreeRootModel
- TreeRootItemsRequestArgsType extends UmbTreeRootItemsRequestArgs = UmbTreeRootItemsRequestArgs
- TreeChildrenOfRequestArgsType extends UmbTreeChildrenOfRequestArgs = UmbTreeChildrenOfRequestArgs
- TreeAncestorsOfRequestArgsType extends UmbTreeAncestorsOfRequestArgs = UmbTreeAncestorsOfRequestArgs
Parameters
- host: UmbControllerHost
  The controller host for this controller to be appended to
- treeSourceConstructor: UmbTreeDataSourceConstructor<TreeItemType>
- treeStoreContextAlias: string | UmbContextToken<any, any>
Returns UmbTreeRepositoryBase<TreeItemType, TreeRootType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>
Memberof
UmbTreeRepositoryBase
Overrides UmbRepositoryBase.constructor
- Defined in src/packages/core/tree/data/tree-repository-base.ts:55

Properties

_host

_host: UmbControllerHost

`Protected`_init

_init: Promise<unknown>

`Protected`_treeSource

_treeSource: UmbTreeDataSource<TreeItemType, UmbTreeRootItemsRequestArgs, UmbTreeChildrenOfRequestArgs, UmbTreeAncestorsOfRequestArgs>

`Protected` `Optional`_treeStore

_treeStore?: UmbTreeStore<TreeItemType>

Accessors

controllerAlias

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

Methods

addEventListener

addEventListener(type, callback, options?): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from UmbRepositoryBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:8337

addUmbController

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

consumeContext

consumeContext<BaseType, ResultType>(alias, callback): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType = unknown
- ResultType = 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
Inherited from UmbRepositoryBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:53

destroy

destroy(): void
Returns void
Implementation of UmbApi.destroy
Inherited from UmbRepositoryBase.destroy
- Defined in src/libs/controller-api/controller.interface.ts:6

dispatchEvent

dispatchEvent(event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from UmbRepositoryBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:8343

getContext

getContext<BaseType, ResultType>(alias): Promise<ResultType>
Type Parameters
- BaseType = unknown
- ResultType = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
Returns Promise<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
Inherited from UmbRepositoryBase.getContext
- Defined in src/libs/class-api/class.interface.ts:64

getHostElement

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

getUmbControllers

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

hasUmbController

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

hostConnected

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

hostDisconnected

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

observe

observe<ObservableType, T, SpecificT, SpecificR>(source, callback, controllerAlias?): 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.
- callback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: null | UmbControllerAlias
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
Inherited from UmbRepositoryBase.observe
- Defined in src/libs/class-api/class.interface.ts:19

provideContext

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

Description
Provide a context API for this or child elements.

Memberof
UmbClassInterface
Inherited from UmbRepositoryBase.provideContext
- Defined in src/libs/class-api/class.interface.ts:44

removeEventListener

removeEventListener(type, callback, options?): void
Removes the event listener in target's event listener list with the same type, callback, and options.

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

removeUmbController

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

removeUmbControllerByAlias

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

requestTreeItemAncestors

requestTreeItemAncestors(args): Promise<{
data: undefined | TreeItemType[];
error: any;
}>
Requests ancestors of a given item
Parameters
- args: TreeAncestorsOfRequestArgsType
Returns Promise<{
data: undefined | TreeItemType[];
error: any;
}>
Memberof
UmbTreeRepositoryBase
Implementation of UmbTreeRepository.requestTreeItemAncestors
- Defined in src/packages/core/tree/data/tree-repository-base.ts:121

requestTreeItemsOf

requestTreeItemsOf(args): Promise<{
    asObservable: (() => Observable<TreeItemType[]>);
    data: undefined | UmbPagedModel<TreeItemType>;
    error: any;
}>
Requests tree items of a given parent
Parameters
- args: TreeChildrenOfRequestArgsType
Returns Promise<{
    asObservable: (() => Observable<TreeItemType[]>);
    data: undefined | UmbPagedModel<TreeItemType>;
    error: any;
}>
Memberof
UmbTreeRepositoryBase
Implementation of UmbTreeRepository.requestTreeItemsOf
- Defined in src/packages/core/tree/data/tree-repository-base.ts:100

`Abstract`requestTreeRoot

requestTreeRoot(): Promise<{
data?: TreeRootType;
error?: ProblemDetails;
}>
Request the tree root item

Returns Promise<{
data?: TreeRootType;
error?: ProblemDetails;
}>
Memberof
UmbTreeRepositoryBase
Implementation of UmbTreeRepository.requestTreeRoot
- Defined in src/packages/core/tree/data/tree-repository-base.ts:73

requestTreeRootItems

requestTreeRootItems(args): Promise<{
    asObservable: (() => Observable<TreeItemType[]>);
    data: undefined | UmbPagedModel<TreeItemType>;
    error: any;
}>
Requests root items of a tree
Parameters
- args: TreeRootItemsRequestArgsType
Returns Promise<{
    asObservable: (() => Observable<TreeItemType[]>);
    data: undefined | UmbPagedModel<TreeItemType>;
    error: any;
}>
Memberof
UmbTreeRepositoryBase
Implementation of UmbTreeRepository.requestTreeRootItems
- Defined in src/packages/core/tree/data/tree-repository-base.ts:81

rootTreeItems

rootTreeItems(): Promise<Observable<TreeItemType[]>>
Returns a promise with an observable of tree root items

Returns Promise<Observable<TreeItemType[]>>
Memberof
UmbTreeRepositoryBase
Implementation of UmbTreeRepository.rootTreeItems
- Defined in src/packages/core/tree/data/tree-repository-base.ts:136

treeItemsOf

treeItemsOf(parentUnique): Promise<Observable<TreeItemType[]>>
Returns a promise with an observable of children items of a given parent
Parameters
- parentUnique: null | string
Returns Promise<Observable<TreeItemType[]>>
Memberof
UmbTreeRepositoryBase
Implementation of UmbTreeRepository.treeItemsOf
- Defined in src/packages/core/tree/data/tree-repository-base.ts:147

Class UmbTreeRepositoryBase<TreeItemType, TreeRootType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>Abstract

Abstract

Implements

Implements

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbTreeRepositoryBase<TreeItemType, TreeRootType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>

Memberof

Properties

_host

Protected_init

Protected_treeSource

Protected Optional_treeStore

Accessors

controllerAlias

Returns UmbControllerAlias

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

getContext

Type Parameters

Parameters

Returns Promise<ResultType>

Description

Memberof

getHostElement

Returns Element

getUmbControllers

Parameters

Parameters

Returns boolean

Returns UmbController[]

hasUmbController

Parameters

Returns boolean

hostConnected

Returns void

hostDisconnected

Returns void

observe

Type Parameters

Parameters

Returns SpecificR

Description

Memberof

provideContext

Type Parameters

Parameters

Returns UmbContextProviderController<R, R, R>

Description

Memberof

removeEventListener

Parameters

Returns void

removeUmbController

Class UmbTreeRepositoryBase<TreeItemType, TreeRootType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>`Abstract`

`Protected`_init

`Protected`_treeSource

`Protected` `Optional`_treeStore

Returns Promise<{
data: undefined | TreeItemType[];
error: any;
}>

Returns Promise<{
asObservable: (() => Observable<TreeItemType[]>);
data: undefined | UmbPagedModel<TreeItemType>;
error: any;
}>

`Abstract`requestTreeRoot

Returns Promise<{
data?: TreeRootType;
error?: ProblemDetails;
}>

Returns Promise<{
asObservable: (() => Observable<TreeItemType[]>);
data: undefined | UmbPagedModel<TreeItemType>;
error: any;
}>