Class StreamableFeatureSource

A feature source that supports streaming features from a remote server (e.g OGC API Features, etc)

Hierarchy (View Summary)

FeatureSourceBase
- StreamableFeatureSource

Index

Constructors

Properties

_initialized _targetCoordinateSystem isStreamableFeatureSource type

Methods

getFeatures initialize throwIfNotInitialized update

Constructors

constructor

new StreamableFeatureSource(
params: StreamableFeatureSourceOptions,
): StreamableFeatureSource
Parameters
- params: StreamableFeatureSourceOptions
Returns StreamableFeatureSource
Overrides FeatureSourceBase.constructor
- Defined in sources/StreamableFeatureSource.ts:240

Properties

`Protected`_initialized

_initialized: boolean = false

`Protected`_targetCoordinateSystem

_targetCoordinateSystem: CoordinateSystem | null = null

`Readonly`isStreamableFeatureSource

isStreamableFeatureSource: true = ...

`Readonly`type

type: "StreamableFeatureSource" = ...

Methods

getFeatures

getFeatures(request: GetFeatureRequest): Promise<GetFeatureResult>
Gets the features matching the request.
Parameters
- request: GetFeatureRequest
  The feature request.
Returns Promise<GetFeatureResult>
Overrides FeatureSourceBase.getFeatures
- Defined in sources/StreamableFeatureSource.ts:304

initialize

initialize(options: { targetCoordinateSystem: CoordinateSystem }): Promise<void>
Initializes the source. The source is not useable before being initialized.
Parameters
- options: { targetCoordinateSystem: CoordinateSystem }
Returns Promise<void>
Inherited from FeatureSourceBase.initialize
- Defined in sources/FeatureSource.ts:78

`Protected`throwIfNotInitialized

throwIfNotInitialized(): void
Returns void
Inherited from FeatureSourceBase.throwIfNotInitialized
- Defined in sources/FeatureSource.ts:93

update

update(): void
Raises an event to reload the source.

Returns void
Inherited from FeatureSourceBase.update
- Defined in sources/FeatureSource.ts:89