Class AbstractAttributeProvider`Abstract`

baseclass for all Objects

Hierarchy (View Summary)

VcsObject
- AbstractAttributeProvider

Implements

AttributeProvider

Index

Accessors

className className

Constructors

Methods

_getAttributes _getBulkAttributes augmentFeature augmentFeatures destroy getLogger toJSON getDefaultOptions

Properties

[moduleIdSymbol]? isDestroyed keyProperty? name properties

Accessors

className

get className(): string
Returns string
Implementation of AttributeProvider.className
Inherited from VcsObject.className
- Defined in src/vcsObject.ts:53

`Static`className

get className(): string
Returns string
Overrides VcsObject.className
- Defined in src/featureProvider/abstractAttributeProvider.ts:38

Constructors

constructor

new AbstractAttributeProvider(
options: AbstractAttributeProviderOptions,
): AbstractAttributeProvider
Parameters
- options: AbstractAttributeProviderOptions
Returns AbstractAttributeProvider
Overrides VcsObject.constructor
- Defined in src/featureProvider/abstractAttributeProvider.ts:53

Methods

`Protected` `Abstract`_getAttributes

_getAttributes(
key: string,
feature: EventFeature,
): Promise<Record<string, unknown> | undefined>
Protected
Retrieves attributes for a given key and feature. Be sure not to use the feature id for lookup, but the provided key.
Parameters
- key: string
  the key to retrieve attributes for
- feature: EventFeature
  the feature requesting the attributes
Returns Promise<Record<string, unknown> | undefined>
- Defined in src/featureProvider/abstractAttributeProvider.ts:106

`Protected`_getBulkAttributes

_getBulkAttributes(
bulk: { feature: EventFeature; key: string }[],
_extent?: Extent,
): Promise<(Record<string, unknown> | undefined)[]>
Protected
Optional bulk attribute retrieval for multiple keys. Can be implemented for optimal loading of data. Provides a webmercator extent to limit the lookup if needed. You MUST return a same length array as keys, with undefined for missing attributes.
Parameters
- bulk: { feature: EventFeature; key: string }[]
  array of key and feature pairs to retrieve attributes for
- Optional_extent: Extent
  optional extent in webmercator to limit attribute lookup on certain providers.
Returns Promise<(Record<string, unknown> | undefined)[]>
- Defined in src/featureProvider/abstractAttributeProvider.ts:120

augmentFeature

augmentFeature(feature: EventFeature): Promise<void>
Augments a feature with attributes from the provider
Parameters
- feature: EventFeature
Returns Promise<void>
Implementation of AttributeProvider.augmentFeature
- Defined in src/featureProvider/abstractAttributeProvider.ts:134

augmentFeatures

augmentFeatures(features: EventFeature[], extent?: Extent): Promise<void>
Augments multiple features with attributes from the provider
Parameters
- features: EventFeature[]
- Optionalextent: Extent
  optional extent in webmercator to limit attribute lookup on certain providers.
Returns Promise<void>
Implementation of AttributeProvider.augmentFeatures
- Defined in src/featureProvider/abstractAttributeProvider.ts:152

destroy

destroy(): void
Returns void
Implementation of AttributeProvider.destroy
Inherited from VcsObject.destroy
- Defined in src/vcsObject.ts:78

getLogger

getLogger(): Logger
Returns Logger
Implementation of AttributeProvider.getLogger
Inherited from VcsObject.getLogger
- Defined in src/vcsObject.ts:57

toJSON

toJSON(
defaultOptions?: AbstractAttributeProviderOptions,
): AbstractAttributeProviderOptions
Parameters
- defaultOptions: AbstractAttributeProviderOptions = ...
Returns AbstractAttributeProviderOptions
Implementation of AttributeProvider.toJSON
Overrides VcsObject.toJSON
- Defined in src/featureProvider/abstractAttributeProvider.ts:189

`Static`getDefaultOptions

getDefaultOptions(): AbstractAttributeProviderOptions
Returns AbstractAttributeProviderOptions
Overrides VcsObject.getDefaultOptions
- Defined in src/featureProvider/abstractAttributeProvider.ts:42

Properties

`Optional`[moduleIdSymbol]

"[moduleIdSymbol]"?: string

isDestroyed

isDestroyed: boolean

`Optional`keyProperty

keyProperty?: string

`Readonly`name

name: string

unique Name

properties

properties: Record<string, unknown>