Class: VectorTile

ol.source.VectorTile

Class for layer sources providing vector data divided into a tile grid, to be used with ol.layer.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 ol.source.Vector for vector sources that are suitable for feature editing.

new ol.source.VectorTile(options)

src/ol/source/vectortile.js, line 29
Name Type Description
options

Vector tile options.

Name Type Description
attributions ol.AttributionLike | undefined

Attributions.

cacheSize number | undefined

Cache size. Default is 128.

format ol.format.Feature | undefined

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

logo string | olx.LogoOptions | undefined

Logo.

overlaps boolean | undefined

This source may have overlapping geometries. Default is true. 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 ol.ProjectionLike

Projection.

state ol.source.State | undefined

Source state.

tileClass function | undefined

Class used to instantiate vector tiles. Default is ol.VectorTile.

tileGrid ol.tilegrid.TileGrid | undefined

Tile grid.

tileLoadFunction ol.TileLoadFunctionType | undefined

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.setFeatures(format.readFeatures(data));
    tile.setProjection(format.readProjection(data));
    // uncomment the line below for ol.format.MVT only
    //tile.setExtent(format.getLastExtent());
  };
});
tileUrlFunction ol.TileUrlFunctionType | undefined

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

url string | undefined

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.

urls Array.<string> | undefined

An array of URL templates.

wrapX boolean | undefined

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. Default is true.

Fires:

Extends

Methods

changed() inherited

src/ol/observable.js, line 58

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

dispatchEvent(event) inherited

src/ol/observable.js, line 75

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 | ol.events.Event | string

Event object.

get(key){*} inherited

src/ol/object.js, line 101

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

getAttributions(){Array.<ol.Attribution>} inherited

src/ol/source/source.js, line 113

Get the attributions of the source.

Returns:
Attributions.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 115

Get a list of object property names.

Returns:
List of property names.

getLogo(){string|olx.LogoOptions|undefined} inherited

src/ol/source/source.js, line 123

Get the logo of the source.

Returns:
Logo.

getProjection(){ol.proj.Projection} inherited

src/ol/source/source.js, line 133

Get the projection of the source.

Returns:
Projection.

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

src/ol/object.js, line 125

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

src/ol/observable.js, line 84

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

Returns:
Revision.

getState(){ol.source.State} inherited

src/ol/source/source.js, line 150

Get the state of the source, see ol.source.State for possible states.

Returns:
State.

getTileGrid(){ol.tilegrid.TileGrid} inherited

src/ol/source/tile.js, line 211

Return the tile grid of the tile source.

Returns:
Tile grid.

getTileLoadFunction(){ol.TileLoadFunctionType} inherited

src/ol/source/urltile.js, line 79

Return the tile load function of the source.

Returns:
TileLoadFunction

getTileUrlFunction(){ol.TileUrlFunctionType} inherited

src/ol/source/urltile.js, line 89

Return the tile URL function of the source.

Returns:
TileUrlFunction

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

src/ol/source/urltile.js, line 101

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, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 99

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.

this Object

The object to use as this in listener.

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, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 124

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.

this Object

The object to use as this in listener.

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

src/ol/source/source.js, line 167

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

set(key, value, opt_silent) inherited

src/ol/object.js, line 150

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean

Update without triggering an event.

setAttributions(attributions) inherited

src/ol/source/source.js, line 179

Set the attributions of the source.

Name Type Description
attributions ol.AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, ol.Attribution, Array<ol.Attribution> or undefined.

setProperties(values, opt_silent) inherited

src/ol/object.js, line 170

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

src/ol/source/urltile.js, line 137

Set the tile load function of the source.

Name Type Description
tileLoadFunction ol.TileLoadFunctionType

Tile load function.

setTileUrlFunction(tileUrlFunction, opt_key) inherited

src/ol/source/urltile.js, line 150

Set the tile URL function of the source.

Name Type Description
tileUrlFunction ol.TileUrlFunctionType

Tile URL function.

key string

Optional new tile key for the source.

setUrl(url) inherited

src/ol/source/urltile.js, line 165

Set the URL to use for requests.

Name Type Description
url string

URL.

setUrls(urls) inherited

src/ol/source/urltile.js, line 178

Set the URLs to use for requests.

Name Type Description
urls Array.<string>

URLs.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 147

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.

this Object

The object which was used as this by the listener.

unset(key, opt_silent) inherited

src/ol/object.js, line 184

Unsets a property.

Name Type Description
key string

Key name.

silent boolean

Unset without triggering an event.