Class UmbTreeServerDataSourceBase<ServerTreeItemType, ClientTreeItemType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>`Abstract`

A data source for a tree that fetches data from the server UmbTreeServerDataSourceBase

Implements

Type Parameters

ServerTreeItemType extends { hasChildren: boolean }
ClientTreeItemType extends UmbTreeItemModel
TreeRootItemsRequestArgsType extends UmbTreeRootItemsRequestArgs = UmbTreeRootItemsRequestArgs
TreeChildrenOfRequestArgsType extends UmbTreeChildrenOfRequestArgs = UmbTreeChildrenOfRequestArgs
TreeAncestorsOfRequestArgsType extends UmbTreeAncestorsOfRequestArgs = UmbTreeAncestorsOfRequestArgs

Hierarchy (View Summary)

UmbControllerBase
- UmbTreeServerDataSourceBase

Implements

UmbTreeDataSource<
    ClientTreeItemType,
    TreeRootItemsRequestArgsType,
    TreeChildrenOfRequestArgsType,
    TreeAncestorsOfRequestArgsType,
>

Constructors

constructor

new UmbTreeServerDataSourceBase<
    ServerTreeItemType extends { hasChildren: boolean },
    ClientTreeItemType extends UmbTreeItemModel,
    TreeRootItemsRequestArgsType extends
        UmbTreeRootItemsRequestArgs = UmbTreeRootItemsRequestArgs,
    TreeChildrenOfRequestArgsType extends
        UmbTreeChildrenOfRequestArgs = UmbTreeChildrenOfRequestArgs,
    TreeAncestorsOfRequestArgsType extends
        UmbTreeAncestorsOfRequestArgs = UmbTreeAncestorsOfRequestArgs,
>(
    host: UmbControllerHost,
    args: UmbTreeServerDataSourceBaseArgs<
        ServerTreeItemType,
        ClientTreeItemType,
        TreeRootItemsRequestArgsType,
        TreeChildrenOfRequestArgsType,
        TreeAncestorsOfRequestArgsType,
    >,
): UmbTreeServerDataSourceBase<
    ServerTreeItemType,
    ClientTreeItemType,
    TreeRootItemsRequestArgsType,
    TreeChildrenOfRequestArgsType,
    TreeAncestorsOfRequestArgsType,
>
Creates an instance of UmbTreeServerDataSourceBase.
Type Parameters
- ServerTreeItemType extends { hasChildren: boolean }
- ClientTreeItemType extends UmbTreeItemModel
- 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
- args: UmbTreeServerDataSourceBaseArgs<
      ServerTreeItemType,
      ClientTreeItemType,
      TreeRootItemsRequestArgsType,
      TreeChildrenOfRequestArgsType,
      TreeAncestorsOfRequestArgsType,
  >
Returns UmbTreeServerDataSourceBase<
    ServerTreeItemType,
    ClientTreeItemType,
    TreeRootItemsRequestArgsType,
    TreeChildrenOfRequestArgsType,
    TreeAncestorsOfRequestArgsType,
>
Memberof
UmbTreeServerDataSourceBase
Overrides UmbControllerBase.constructor
- Defined in src/packages/core/tree/data/tree-server-data-source-base.ts:62

Properties

_host

_host: UmbControllerHost

Accessors

controllerAlias

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

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
Inherited from UmbControllerBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbControllerBase.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
Inherited from UmbControllerBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

destroy

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

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
Inherited from UmbControllerBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

getAncestorsOf

getAncestorsOf(
    args: TreeAncestorsOfRequestArgsType,
): Promise<
    | { data: ClientTreeItemType[]; error?: undefined }
    | {
        data?: undefined;
        error:
            | undefined
            | (
                (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
            );
    },
>
Fetches the ancestors of a given item from the server
Parameters
- args: TreeAncestorsOfRequestArgsType
Returns Promise<
    | { data: ClientTreeItemType[]; error?: undefined }
    | {
        data?: undefined;
        error:
            | undefined
            | (
                (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
            );
    },
>
Memberof
UmbTreeServerDataSourceBase
Implementation of UmbTreeDataSource.getAncestorsOf
- Defined in src/packages/core/tree/data/tree-server-data-source-base.ts:135

getChildrenOf

getChildrenOf(
    args: TreeChildrenOfRequestArgsType,
): Promise<
    | {
        data: {
            items: ClientTreeItemType[];
            total: number;
            totalAfter: undefined
            | number;
            totalBefore: undefined | number;
        };
        error?: undefined;
    }
    | {
        data?: undefined;
        error: | undefined
        | (
            (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
        );
    },
>
Fetches the children of a given parent unique from the server
Parameters
- args: TreeChildrenOfRequestArgsType
Returns Promise<
    | {
        data: {
            items: ClientTreeItemType[];
            total: number;
            totalAfter: undefined
            | number;
            totalBefore: undefined | number;
        };
        error?: undefined;
    }
    | {
        data?: undefined;
        error: | undefined
        | (
            (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
        );
    },
>
Memberof
UmbTreeServerDataSourceBase
Implementation of UmbTreeDataSource.getChildrenOf
- Defined in src/packages/core/tree/data/tree-server-data-source-base.ts:109

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
Inherited from UmbControllerBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getHostElement

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

getRootItems

getRootItems(
    args: TreeRootItemsRequestArgsType,
): Promise<
    | {
        data: {
            items: ClientTreeItemType[];
            total: number;
            totalAfter: undefined
            | number;
            totalBefore: undefined | number;
        };
        error?: undefined;
    }
    | {
        data?: undefined;
        error: | undefined
        | (
            (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
        );
    },
>
Fetches the root items for the tree from the server
Parameters
- args: TreeRootItemsRequestArgsType
Returns Promise<
    | {
        data: {
            items: ClientTreeItemType[];
            total: number;
            totalAfter: undefined
            | number;
            totalBefore: undefined | number;
        };
        error?: undefined;
    }
    | {
        data?: undefined;
        error: | undefined
        | (
            (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
        );
    },
>
Memberof
UmbTreeServerDataSourceBase
Implementation of UmbTreeDataSource.getRootItems
- Defined in src/packages/core/tree/data/tree-server-data-source-base.ts:85

getUmbControllers

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

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
Inherited from UmbControllerBase.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
Inherited from UmbControllerBase.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
Inherited from UmbControllerBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

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

removeUmbControllerByAlias

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

Class UmbTreeServerDataSourceBase<ServerTreeItemType, ClientTreeItemType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>Abstract

Implements

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbTreeServerDataSourceBase< ServerTreeItemType, ClientTreeItemType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType,>

Memberof

Properties

_host

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

getAncestorsOf

Parameters

Returns Promise< | { data: ClientTreeItemType[]; error?: undefined } | { data?: undefined; error: | undefined | ( (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError) ); },>

Memberof

getChildrenOf

Parameters

Returns Promise< | { data: { items: ClientTreeItemType[]; total: number; totalAfter: undefined | number; totalBefore: undefined | number; }; error?: undefined; } | { data?: undefined; error: | undefined | ( (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError) ); },>

Memberof

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getHostElement

Returns Element

getRootItems

Parameters

Returns Promise< | { data: { items: ClientTreeItemType[]; total: number; totalAfter: undefined | number; totalBefore: undefined | number; }; error?: undefined; } | { data?: undefined; error: | undefined | ( (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError) ); },>

Memberof

getUmbControllers

Parameters

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>

Description

Class UmbTreeServerDataSourceBase<ServerTreeItemType, ClientTreeItemType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>`Abstract`

Returns UmbTreeServerDataSourceBase<
ServerTreeItemType,
ClientTreeItemType,
TreeRootItemsRequestArgsType,
TreeChildrenOfRequestArgsType,
TreeAncestorsOfRequestArgsType,
>

Returns Promise<
| { data: ClientTreeItemType[]; error?: undefined }
| {
data?: undefined;
error:
| undefined
| (
(Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
);
},
>

Returns Promise<
| {
data: {
items: ClientTreeItemType[];
total: number;
totalAfter: undefined
| number;
totalBefore: undefined | number;
};
error?: undefined;
}
| {
data?: undefined;
error: | undefined
| (
(Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
);
},
>

Returns Promise<
| {
data: {
items: ClientTreeItemType[];
total: number;
totalAfter: undefined
| number;
totalBefore: undefined | number;
};
error?: undefined;
}
| {
data?: undefined;
error: | undefined
| (
(Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
);
},
>