Class UmbDefaultCollectionContext<CollectionItemType, FilterModelType>

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

Type Parameters

CollectionItemType extends { entityType: string; unique: string } = any
FilterModelType extends UmbCollectionFilterModel = UmbCollectionFilterModel

Hierarchy (View Summary)

UmbContextBase
- UmbDefaultCollectionContext

Implements

Constructors

constructor

new UmbDefaultCollectionContext<
    CollectionItemType extends { entityType: string; unique: string } = any,
    FilterModelType extends UmbCollectionFilterModel = UmbCollectionFilterModel,
>(
    host: UmbControllerHost,
    defaultViewAlias: string,
    defaultFilter?: Partial<FilterModelType>,
): UmbDefaultCollectionContext<CollectionItemType, FilterModelType>
Type Parameters
- CollectionItemType extends { entityType: string; unique: string } = any
- FilterModelType extends UmbCollectionFilterModel = UmbCollectionFilterModel
Parameters
- host: UmbControllerHost
- defaultViewAlias: string
- defaultFilter: Partial<FilterModelType> = {}
Returns UmbDefaultCollectionContext<CollectionItemType, FilterModelType>
Overrides UmbContextBase.constructor
- Defined in src/packages/core/collection/default/collection-default.context.ts:88

Properties

`Protected`_configured

_configured: boolean = false

`Protected`_filter

_filter: UmbObjectState<object | FilterModelType> = ...

_host

_host: UmbControllerHost

`Protected`_init

_init: Promise<void> = ...

`Protected`_items

_items: UmbArrayState<CollectionItemType, unknown> = ...

`Protected`_loading

_loading: UmbObjectState<boolean> = ...

`Protected` `Optional`_manifest

_manifest?: ManifestCollection

`Protected` `Optional`_repository

_repository?: UmbCollectionRepository<any, UmbCollectionFilterModel>

`Protected`_totalItems

_totalItems: UmbNumberState<number> = ...

`Readonly`filter

filter: Observable<object | FilterModelType> = ...

`Readonly`items

items: Observable<CollectionItemType[]> = ...

`Readonly`loading

loading: Observable<boolean> = ...

`Readonly`pagination

pagination: UmbPaginationManager = ...

`Readonly`selection

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

`Readonly`totalItems

totalItems: Observable<number> = ...

`Readonly`userDefinedProperties

userDefinedProperties: Observable<UmbCollectionColumnConfiguration[]> = ...

`Readonly`view

view: UmbCollectionViewManager = ...

`Readonly`viewLayouts

viewLayouts: Observable<UmbCollectionLayoutConfiguration[]> = ...

`Readonly`workspacePathBuilder

workspacePathBuilder: Observable<undefined | UmbModalRouteBuilder> = ...

Accessors

controllerAlias

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

manifest

get manifest(): undefined | ManifestCollection
Returns undefined | ManifestCollection
- Defined in src/packages/core/collection/default/collection-default.context.ts:242
set manifest(manifest: undefined | ManifestCollection): void
Parameters
- manifest: undefined | ManifestCollection
Returns void
- Defined in src/packages/core/collection/default/collection-default.context.ts:237

Methods

`Protected`_configure

_configure(): void
Returns void
- Defined in src/packages/core/collection/default/collection-default.context.ts:162

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

addUmbController

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

destroy

destroy(): void
Returns void
Implementation of UmbApi.destroy
Overrides UmbContextBase.destroy
- Defined in src/packages/core/collection/default/collection-default.context.ts:330

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

getConfig

getConfig(): undefined | UmbCollectionConfiguration
Returns undefined | UmbCollectionConfiguration
Implementation of UmbCollectionContext.getConfig
- Defined in src/packages/core/collection/default/collection-default.context.ts:233

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

getLastSelectedView

getLastSelectedView(unique: undefined | string): undefined | string
Parameters
- unique: undefined | string
Returns undefined | string
- Defined in src/packages/core/collection/default/collection-default.context.ts:290

getManifest

getManifest(): undefined | ManifestCollection
Returns the manifest for the collection.

Returns undefined | ManifestCollection
Memberof
UmbCollectionContext

Deprecated
Use the .manifest property instead.
Implementation of UmbCollectionContext.getManifest
- Defined in src/packages/core/collection/default/collection-default.context.ts:364

getUmbControllers

getUmbControllers(
filterMethod: (ctrl: UmbController) => boolean,
): UmbController[]
Parameters
- filterMethod: (ctrl: UmbController) => boolean
Returns UmbController[]
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
Inherited from UmbContextBase.hasUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:4

hostConnected

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

hostDisconnected

hostDisconnected(): void
Returns void
Inherited from UmbContextBase.hostDisconnected
- Defined in src/libs/controller-api/controller.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 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
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
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
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
Inherited from UmbContextBase.removeUmbControllerByAlias
- Defined in src/libs/controller-api/controller-host.interface.ts:7

requestCollection

requestCollection(): Promise<void>
Requests the collection from the repository.

Returns Promise<void>
Memberof
UmbCollectionContext
Implementation of UmbCollectionContext.requestCollection
- Defined in src/packages/core/collection/default/collection-default.context.ts:255

setConfig

setConfig(config: UmbCollectionConfiguration): void
Sets the configuration for the collection.
Parameters
- config: UmbCollectionConfiguration
Returns void
Memberof
UmbCollectionContext
Implementation of UmbCollectionContext.setConfig
- Defined in src/packages/core/collection/default/collection-default.context.ts:229

setFilter

setFilter(filter: Partial<FilterModelType>): void
Sets the filter for the collection and refreshes the collection.
Parameters
- filter: Partial<FilterModelType>
Returns void
Memberof
UmbCollectionContext
- Defined in src/packages/core/collection/default/collection-default.context.ts:281

setLastSelectedView

setLastSelectedView(unique: undefined | string, viewAlias: string): void
Parameters
- unique: undefined | string
- viewAlias: string
Returns void
- Defined in src/packages/core/collection/default/collection-default.context.ts:299

setManifest

setManifest(manifest: undefined | ManifestCollection): void
Sets the manifest for the collection.
Parameters
- manifest: undefined | ManifestCollection
Returns void
Memberof
UmbCollectionContext

Deprecated
Use set the .manifest property instead.
Implementation of UmbCollectionContext.setManifest
- Defined in src/packages/core/collection/default/collection-default.context.ts:350

setupView

setupView(viewElement: UmbControllerHost): void
Parameters
- viewElement: UmbControllerHost
Returns void
- Defined in src/packages/core/collection/default/collection-default.context.ts:115

updateFilter

updateFilter(filter: Partial<FilterModelType>): void
Parameters
- filter: Partial<FilterModelType>
Returns void
- Defined in src/packages/core/collection/default/collection-default.context.ts:286

Class UmbDefaultCollectionContext<CollectionItemType, FilterModelType>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbDefaultCollectionContext<CollectionItemType, FilterModelType>

Properties

Protected_configured

Protected_filter

_host

Protected_init

Protected_items

Protected_loading

Protected Optional_manifest

Protected Optional_repository

Protected_totalItems

Readonlyfilter

Readonlyitems

Readonlyloading

Readonlypagination

Readonlyselection

ReadonlytotalItems

ReadonlyuserDefinedProperties

Readonlyview

ReadonlyviewLayouts

ReadonlyworkspacePathBuilder

Accessors

controllerAlias

Returns UmbControllerAlias

manifest

Returns undefined | ManifestCollection

Parameters

Returns void

Methods

Protected_configure

Returns void

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

getConfig

Returns undefined | UmbCollectionConfiguration

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getEmptyLabel

Returns string

getHostElement

Returns Element

getItems

Returns CollectionItemType[]

getLastSelectedView

Parameters

Returns undefined | string

getManifest

Returns undefined | ManifestCollection

`Protected`_configured

`Protected`_filter

`Protected`_init

`Protected`_items

`Protected`_loading

`Protected` `Optional`_manifest

`Protected` `Optional`_repository

`Protected`_totalItems

`Readonly`filter

`Readonly`items

`Readonly`loading

`Readonly`pagination

`Readonly`selection

`Readonly`totalItems

`Readonly`userDefinedProperties

`Readonly`view

`Readonly`viewLayouts

`Readonly`workspacePathBuilder

`Protected`_configure