Class: VectorTile

ol/source/VectorTile~VectorTile 


import VectorTile from 'ol/source/VectorTile';

Class for layer sources providing vector data divided into a tile grid, to be used with module:ol/layer/VectorTile~VectorTile. Although this source receives tiles with vector features from the server, it is not meant for feature editing. Features are optimized for rendering, their geometries are clipped at or near tile boundaries and simplified for a view resolution. See module:ol/source/Vector for vector sources that are suitable for feature editing.

new VectorTile(options)

source/VectorTile.js, line 75
Name Type Description
options

Vector tile options.

Name Type Default Description
attributions module:ol/source/Source~AttributionLike

Attributions.
cacheSize number 128

Cache size.
extent module:ol/extent~Extent
format module:ol/format/Feature~FeatureFormat

Feature format for tiles. Used and required by the default.
overlaps boolean 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 module:ol/proj~ProjectionLike

Projection.
state module:ol/source/State

Source state.
tileClass Class.<module:ol/VectorTile~VectorTile>

Class used to instantiate image tiles. Default is module:ol/VectorTile.
maxZoom number 22

Optional max zoom level.
minZoom number

Optional min zoom level.
tileSize number | module:ol/size~Size 512

Optional tile size.
tileGrid module:ol/tilegrid/TileGrid~TileGrid

Tile grid.
tileLoadFunction module:ol/Tile~LoadFunction

Optional function to load a tile given a URL. Could look like this:

function(tile, url) {
  tile.setLoader(function() {
    var data = // ... fetch data
    var format = tile.getFormat();
    tile.setProjection(format.readProjection(data));
    tile.setFeatures(format.readFeatures(data, {
      // featureProjection is not required for ol/format/MVT
      featureProjection: map.getView().getProjection()
    }));
    // the line below is only required for ol/format/MVT
    tile.setExtent(format.getLastExtent());
  }
});
tileUrlFunction module:ol/Tile~UrlFunction

Optional function to get tile URL given a tile coordinate and the projection.
url string

URL template. Must include {x}, {y} or {-y}, and {z} placeholders. A {?-?} template pattern, for example subdomain{a-f}.domain.com, may be used instead of defining each one separately in the urls option.
transition number

A duration for tile opacity transitions in milliseconds. A duration of 0 disables the opacity transition.
urls Array.<string>

An array of URL templates.
wrapX boolean 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.
Fires:

Extends

Methods

changed() inherited

Observable.js, line 36

Increases the revision counter and dispatches a 'change' event.

clear()

source/VectorTile.js, line 149

clear module:ol/TileCache~TileCache and delete all source tiles

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 82

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event Object | module:ol/events/Event~Event | string

Event object.
Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 119

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getKeys(){Array.<string>} inherited

Object.js, line 132

Get a list of object property names.

Returns:
List of property names.

getProjection(){module:ol/proj/Projection~Projection} inherited

source/Source.js, line 119

Get the projection of the source.

Returns:
Projection.

getProperties(){Object.<string, *>} inherited

Object.js, line 141

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 47

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

getState(){module:ol/source/State} inherited

source/Source.js, line 136

Get the state of the source, see module:ol/source/State~State for possible states.

Returns:
State.

getTileGrid(){module:ol/tilegrid/TileGrid~TileGrid} inherited

source/Tile.js, line 213

Return the tile grid of the tile source.

Returns:
Tile grid.

getTileLoadFunction(){module:ol/Tile~LoadFunction} inherited

source/UrlTile.js, line 104

Return the tile load function of the source.

Returns:
TileLoadFunction

getTileUrlFunction(){module:ol/Tile~UrlFunction} inherited

source/UrlTile.js, line 113

Return the tile URL function of the source.

Returns:
TileUrlFunction

getUrls(){!Array.<string>|null} inherited

source/UrlTile.js, line 124

Return the URLs used for this source. When a tileUrlFunction is used instead of url or urls, null will be returned.

Returns:
URLs.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 60

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 82

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

refresh() inherited

source/Source.js, line 151

Refreshes the source and finally dispatches a 'change' event.

set(key, value, opt_silent) inherited

Object.js, line 164

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setAttributions(attributions) inherited

source/Source.js, line 162

Set the attributions of the source.

Name Type Description
attributions module:ol/source/Source~AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, module:ol/source/Source&tilde;Attribution, or undefined.

setProperties(values, opt_silent) inherited

Object.js, line 183

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.
silent boolean

Update without triggering an event.

setTileLoadFunction(tileLoadFunction) inherited

source/UrlTile.js, line 157

Set the tile load function of the source.

Name Type Description
tileLoadFunction module:ol/Tile~LoadFunction

Tile load function.

setTileUrlFunction(tileUrlFunction, key) inherited

source/UrlTile.js, line 169

Set the tile URL function of the source.

Name Type Description
tileUrlFunction module:ol/Tile~UrlFunction

Tile URL function.
key string

Optional new tile key for the source.

setUrl(url) inherited

source/UrlTile.js, line 184

Set the URL to use for requests.

Name Type Description
url string

URL.

setUrls(urls) inherited

source/UrlTile.js, line 194

Set the URLs to use for requests.

Name Type Description
urls Array.<string>

URLs.

un(type, listener) inherited

Observable.js, line 101

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.

unset(key, opt_silent) inherited

Object.js, line 195

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.