Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 3.06 KB

ShapeSource.md

File metadata and controls

49 lines (34 loc) · 3.06 KB
Raw

<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

Prop Type Default Required Description
id string MapboxGL.StyleSource.DefaultSourceID false A string that uniquely identifies the source.
url string none false An HTTP(S) URL, absolute file URL, or local file URL relative to the current application’s resource bundle.
shape object none false The contents of the source. A shape can represent a GeoJSON geometry, a feature, or a feature colllection.
cluster bool none false Enables clustering on the source for point shapes.
clusterRadius number none false Specifies 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.
clusterMaxZoomLevel number none false Specifies 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.
maxZoomLevel number none false Specifies 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.
buffer number none false Specifies 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.
tolerance number none false Specifies the Douglas-Peucker simplification tolerance.
A greater value produces simpler geometries and improves performance.
The default value is 0.375.
onPress func none false Source 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
hitbox shape none false Overrides the default touch hitbox(44x44 pixels) for the source layers
  width number none true FIX ME NO DESCRIPTION
  height number none true FIX ME NO DESCRIPTION

methods

features([filter])

Returns all features from the source that match the query parameters regardless of whether or not the feature is
currently rendered on the map.

arguments
Name Type Required Description
filter Array No an optional filter statement to filter the returned Features. 
shapeSource.features()

onPress(event)

arguments
Name Type Required Description
event n/a Yes undefined