Module: ol/source/OGCVectorTile

ol/source/OGCVectorTile


Classes

OGCVectorTile

Type Definitions

Options{Object}

Properties:
Name Type Description
url string

URL to the OGC Vector Tileset endpoint.

context Object | undefined

A lookup of values to use in the tile URL template. The {tileMatrix} (zoom level), {tileRow}, and {tileCol} variables in the URL will always be provided by the source.

format FeatureFormat<FeatureType> | undefined

Feature format for tiles. Used and required by the default.

mediaType string | undefined

The content type for the tiles (e.g. "application/vnd.mapbox-vector-tile"). If not provided, the source will try to find a link with rel="item" that uses a vector type supported by the configured format.

attributions AttributionLike | undefined

Attributions.

attributionsCollapsible boolean
(defaults to true)

Attributions are collapsible.

cacheSize number | undefined

Deprecated. Use the cacheSize option on the layer instead.

overlaps boolean
(defaults to true)

This source may have overlapping geometries. Setting this to false (e.g. for sources with polygons that represent administrative boundaries or TopoJSON sources) allows the renderer to optimise fill and stroke operations.

projection ProjectionLike
(defaults to 'EPSG:3857')

Projection of the tile grid.

tileClass Class<VectorTile> | undefined

Class used to instantiate image tiles. Default is VectorTile.

transition number | undefined

A duration for tile opacity transitions in milliseconds. A duration of 0 disables the opacity transition.

wrapX boolean
(defaults to true)

Whether to wrap the world horizontally. When set to false, only one world will be rendered. When set to true, tiles will be wrapped horizontally to render multiple worlds.

zDirection number | NearestDirectionFunction
(defaults to 1)

Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See getZForResolution.

collections Array.<string> | undefined

A list of geospatial data sub-resources to include. If not provided, the entire dataset will be included. This option is not applicable when requesting the tileset for a single collection.