Interface OverpassApiVectorSourceOptions

These are properties for Overpass API vector source.

interface OverpassApiVectorSourceOptions {
    additionalOptions?: Options<Feature<Geometry>>;
    baseUrl: string;
    mapProjection: ProjectionLike;
    query: string;
    rewriteUrl?: (url: URL) => undefined | URL;
    timeout?: number;
}

Properties

additionalOptions? baseUrl mapProjection query rewriteUrl? timeout?

Properties

OptionaladditionalOptions

additionalOptions?: Options<Feature<Geometry>>

Optional additional options for the VectorSource.

baseUrl

baseUrl: string

The base-URL to an Overpass API instance (e.g. https://overpass-api.de/api/interpreter).

mapProjection

mapProjection: ProjectionLike

Current map projection (e.g. EPSG:3857)

query

query: string

Overpass API query part (e.g. node[amenity=post_box];).

OptionalrewriteUrl

rewriteUrl?: (url: URL) => undefined | URL

Use this function to rewrite the URL used to fetch features from an Overpass API service.

NOTE: Do not update the url argument. Return a new URL instance instead.

NOTE: Be careful with existing URL parameters. The vector source may not work correctly if predefined parameters are overwritten. The vector source might add additional parameters to its request URLs in the future.

Optionaltimeout

timeout?: number

Request delay (in milliseconds) before the async query starts. Defaults to 25.

Settings

Member Visibility

On This Page

Properties