Interface AttributeProvider

baseclass for all Objects

interface AttributeProvider {
    [moduleIdSymbol]?: string;
    isDestroyed: boolean;
    name: string;
    properties: Record<string, unknown>;
    get className(): string;
    augmentFeature(feature: EventFeature): Promise<void>;
    augmentFeatures(features: EventFeature[], extent?: Extent): Promise<void>;
    destroy(): void;
    getLogger(): Logger;
    toJSON(_defaultOptions?: VcsObjectOptions): VcsObjectOptions;
}

Hierarchy (view full)

VcsObject
- AttributeProvider

Implemented by

Index

Accessors

Methods

augmentFeature augmentFeatures destroy getLogger toJSON

Properties

[moduleIdSymbol]? isDestroyed name properties

Accessors

className

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

Methods

augmentFeature

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

augmentFeatures

augmentFeatures(features, 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>
- Defined in src/featureProvider/abstractAttributeProvider.ts:31

destroy

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

getLogger

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

toJSON

toJSON(_defaultOptions?): VcsObjectOptions
Parameters
- Optional_defaultOptions: VcsObjectOptions
Returns VcsObjectOptions
Inherited from VcsObject.toJSON
- Defined in src/vcsObject.ts:62

Properties

`Optional`[moduleIdSymbol]

[moduleIdSymbol]?: string

isDestroyed

isDestroyed: boolean

`Readonly`name

name: string

unique Name

properties

properties: Record<string, unknown>