VectorTileSource class
A vector tile source describes how to access a vector tile layer. Vector tile sources can be used with; SymbolLayer, LineLayer, PolygonLayer, BubbleLayer, HeatmapLayer and VectorTileLayer.
- Extends
Constructors
Vector |
Methods
get |
Gets the options of the VectorTileSource. |
get |
Returns all GeoJSON features that are in the VectorTileSource and which satisfy the specified filter expression. |
Inherited Methods
get |
Gets the id of the data source |
Constructor Details
VectorTileSource(string, VectorTileSourceOptions)
new VectorTileSource(id?: string, options?: VectorTileSourceOptions)
Parameters
- id
-
string
- options
- VectorTileSourceOptions
Method Details
getOptions()
Gets the options of the VectorTileSource.
function getOptions(): VectorTileSourceOptions
Returns
getShape(string, Expression)
Returns all GeoJSON features that are in the VectorTileSource and which satisfy the specified filter expression.
function getShape(sourceLayer: string, filter?: Expression): Array<Feature<atlas.data.Geometry, any>>
Parameters
- sourceLayer
-
string
Required if the source is a VectorTileSource. Specifies the layer within the VectorTileSource to query.
- filter
- Expression
A filter that will limit the query.