ShapeSource.md

February 16, 2018 · View on GitHub

<MapboxGL.ShapeSource />

ShapeSource is a map content source that supplies vector shapes to be shown on the map.
The shape may be a url or a GeoJSON object

props

PropTypeDefaultRequiredDescription
idstringMapboxGL.StyleSource.DefaultSourceIDfalseA string that uniquely identifies the source.
urlstringnonefalseAn HTTP(S) URL, absolute file URL, or local file URL relative to the current application’s resource bundle.
shapeobjectnonefalseThe contents of the source. A shape can represent a GeoJSON geometry, a feature, or a feature colllection.
clusterboolnonefalseEnables clustering on the source for point shapes.
clusterRadiusnumbernonefalseSpecifies the radius of each cluster if clustering is enabled.
A value of 512 produces a radius equal to the width of a tile.
The default value is 50.
clusterMaxZoomLevelnumbernonefalseSpecifies the maximum zoom level at which to cluster points if clustering is enabled.
Defaults to one zoom level less than the value of maxZoomLevel so that, at the maximum zoom level,
the shapes are not clustered.
maxZoomLevelnumbernonefalseSpecifies the maximum zoom level at which to create vector tiles.
A greater value produces greater detail at high zoom levels.
The default value is 18.
buffernumbernonefalseSpecifies the size of the tile buffer on each side.
A value of 0 produces no buffer. A value of 512 produces a buffer as wide as the tile itself.
Larger values produce fewer rendering artifacts near tile edges and slower performance.
The default value is 128.
tolerancenumbernonefalseSpecifies the Douglas-Peucker simplification tolerance.
A greater value produces simpler geometries and improves performance.
The default value is 0.375.
imagesobjectnonefalseSpecifies the external images in key-value pairs required for the shape source.
If you have an asset under Image.xcassets on iOS and the drawables directory on android
you can specify an array of string names with assets as the key { assets: ['pin'] }.
onPressfuncnonefalseSource press listener, gets called when a user presses one of the children layers only
if that layer has a higher z-index than another source layers
hitboxshapenonefalseOverrides the default touch hitbox(44x44 pixels) for the source layers