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~VectorSource for vector sources that are suitable for feature
editing.
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.
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());
};
});
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.