API.md

Table of Contents

• VectorTiles
• initialize
• search
• hideByProperty
• showByProperty
• restyleByProperty
• setFeatureStyle
• getLayer
• getGeoJSON
• removeFeature

VectorTiles

Extends GridLayer

Manages interactive tiles of data

Examples

var vtLayer = new L.VectorTiles('http://mytiles.com/{z}/{x}/{y}.pbf', {
  map: map,
  debug: true
}).addTo(map);

initialize

Constructor

Parameters

• url string The template url for fectching vector tiles
• options Object
  • options.getFeatureId Function?
  • options.debug boolean?
  • options.style Object?

search

Returns an array of feature ids near a given point

Parameters

• min L.LatLng
• max L.LatLng

Returns Array<string>

hideByProperty

Removes features from the map by property. Wrapper function of _toggleByProperty. Equivalent to this._toggleByProperty(property, value, false).

Parameters

• property string
• value string

showByProperty

Add features to the map by property. Wrapper function of _toggleByProperty. Equivalent to this._toggleByProperty(property, value, true).

Parameters

• property string
• value string

restyleByProperty

Change the style of features based on property values

Parameters

• property string
• value string
• style Object

Returns L.VectorTiles this

setFeatureStyle

Change the style of a feature by its id

Parameters

• id string
• style Object

Returns L.VectorTiles this

getLayer

Returns a reference to the layer identified by the id

Parameters

• id string

Returns L.Path

getGeoJSON

Returns a reference to the GeoJSON feature identified by the id

Parameters

• id string

Returns Object

removeFeature

Deletes a feature by its ID Note that this feature will still be loaded in subsequent tiles

Parameters

• id string

Returns L.VectorTiles this