Interface FeatureSource

Interface for feature sources.

Note

To implement a feature source, you can use the FeatureSourceBase base class for convenience.

interface FeatureSource {
    getFeatures(request: GetFeatureRequest): Promise<GetFeatureResult>;
    initialize(
        options: { targetCoordinateSystem: CoordinateSystem },
    ): Promise<void>;
}

Hierarchy

EventDispatcher<FeatureSourceEventMap>
- FeatureSource

Implemented by

FeatureSourceBase

Index

Methods

getFeatures initialize

Methods

getFeatures

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

initialize

initialize(options: { targetCoordinateSystem: CoordinateSystem }): Promise<void>
Initializes the source. The source is not useable before being initialized.
Parameters
- options: { targetCoordinateSystem: CoordinateSystem }
  - targetCoordinateSystem: CoordinateSystem
    The coordinate system of features that are generated by this source. The source is responsible for reprojecting features if their original CRS is different from the target.
Returns Promise<void>
- Defined in sources/FeatureSource.ts:50