Interface UmbCollectionContext

interface UmbCollectionContext {
    items: Observable<any[]>;
    pagination: UmbPaginationManager;
    totalItems: Observable<number>;
    getConfig(): undefined | UmbCollectionConfiguration;
    getManifest(): undefined | ManifestCollection;
    requestCollection(): Promise<void>;
    setConfig(config: UmbCollectionConfiguration): void;
    setManifest(manifest: ManifestCollection): void;
}

Implemented by

UmbDefaultCollectionContext

Index

Properties

items pagination totalItems

Methods

getConfig getManifest requestCollection setConfig setManifest

Properties

items

items: Observable<any[]>

pagination

pagination: UmbPaginationManager

totalItems

totalItems: Observable<number>

Methods

getConfig

getConfig(): undefined | UmbCollectionConfiguration
Returns undefined | UmbCollectionConfiguration
- Defined in src/packages/core/collection/types.ts:48

getManifest

getManifest(): undefined | ManifestCollection
Returns undefined | ManifestCollection
- Defined in src/packages/core/collection/types.ts:50

requestCollection

requestCollection(): Promise<void>
Returns Promise<void>
- Defined in src/packages/core/collection/types.ts:51

setConfig

setConfig(config: UmbCollectionConfiguration): void
Parameters
- config: UmbCollectionConfiguration
Returns void
- Defined in src/packages/core/collection/types.ts:47

setManifest

setManifest(manifest: ManifestCollection): void
Parameters
- manifest: ManifestCollection
Returns void
- Defined in src/packages/core/collection/types.ts:49