Class JSONAttributeProvider

baseclass for all Objects

Hierarchy (View Summary)

AbstractAttributeProvider
- JSONAttributeProvider

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
Inherited from AbstractAttributeProvider.className
- Defined in src/vcsObject.ts:53

`Static`className

get className(): string
Returns string
Overrides AbstractAttributeProvider.className
- Defined in src/featureProvider/jsonAttributeProvider.ts:18

Constructors

constructor

new JSONAttributeProvider(
options: JsonAttributeProviderOptions,
): JSONAttributeProvider
Parameters
- options: JsonAttributeProviderOptions
Returns JSONAttributeProvider
Overrides AbstractAttributeProvider.constructor
- Defined in src/featureProvider/jsonAttributeProvider.ts:35

Methods

`Protected`_getAttributes

_getAttributes(key: string): 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
Returns Promise<Record<string, unknown> | undefined>
Overrides AbstractAttributeProvider._getAttributes
- Defined in src/featureProvider/jsonAttributeProvider.ts:72

`Protected`_getBulkAttributes

_getBulkAttributes(
bulk: { key: string }[],
): 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: { key: string }[]
  array of key and feature pairs to retrieve attributes for
Returns Promise<(Record<string, unknown> | undefined)[]>
Overrides AbstractAttributeProvider._getBulkAttributes
- Defined in src/featureProvider/jsonAttributeProvider.ts:79

augmentFeature

augmentFeature(feature: EventFeature): Promise<void>
Augments a feature with attributes from the provider
Parameters
- feature: EventFeature
Returns Promise<void>
Inherited from AbstractAttributeProvider.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>
Inherited from AbstractAttributeProvider.augmentFeatures
- Defined in src/featureProvider/abstractAttributeProvider.ts:152

destroy

destroy(): void
Returns void
Overrides AbstractAttributeProvider.destroy
- Defined in src/featureProvider/jsonAttributeProvider.ts:105

getLogger

getLogger(): Logger
Returns Logger
Inherited from AbstractAttributeProvider.getLogger
- Defined in src/vcsObject.ts:57

toJSON

toJSON(
defaultOptions?: JsonAttributeProviderOptions,
): JsonAttributeProviderOptions
Parameters
- defaultOptions: JsonAttributeProviderOptions = ...
Returns JsonAttributeProviderOptions
Overrides AbstractAttributeProvider.toJSON
- Defined in src/featureProvider/jsonAttributeProvider.ts:88

`Static`getDefaultOptions

getDefaultOptions(): JsonAttributeProviderOptions
Returns JsonAttributeProviderOptions
Overrides AbstractAttributeProvider.getDefaultOptions
- Defined in src/featureProvider/jsonAttributeProvider.ts:22

Properties

`Optional`[moduleIdSymbol]

"[moduleIdSymbol]"?: string

isDestroyed

isDestroyed: boolean

`Optional`keyProperty

keyProperty?: string

`Readonly`name

name: string

unique Name

properties

properties: Record<string, unknown>