ShapeSource.md

<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.
clusterProperties	object	none	false	[mapbox-gl (v8) implementation only] Specifies custom properties on the generated clusters if clustering is enabled, aggregating values from clustered points. Has the form { "property_name": [operator, map_expression]}, where operator is a custom reduce expression that references a special ["accumulated"] value - it accumulates the property value from clusters/points the cluster contains map_expression produces the value of a single point Example: { "resultingSum": [["+", ["accumulated"], ["get", "resultingSum"]], ["get", "scalerank"]] }
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.
lineMetrics	bool	none	false	Whether to calculate line distance metrics. This is required for line layers that specify lineGradient values. The default value is false.
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	width of hitbox
height	number	none	true	height of hitbox

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()

getClusterExpansionZoom(feature)

Returns the zoom needed to expand the cluster.

arguments

Name	Type	Required	Description
feature	Feature	Yes	The feature cluster to expand.

const zoom = await shapeSource.getClusterExpansionZoom(clusterId);

getClusterLeaves(feature, limit, offset)

Returns the FeatureCollection from the cluster.

arguments

Name	Type	Required	Description
feature	Feature	Yes	The feature cluster to expand.
limit	number	Yes	The number of points to return.
offset	number	Yes	The amount of points to skip (for pagination).

const collection = await shapeSource.getClusterLeaves(clusterId, limit, offset);

getClusterChildren(feature)

Returns the FeatureCollection from the cluster (on the next zoom level).

arguments

Name	Type	Required	Description
feature	Feature	Yes	The feature cluster to expand.

const collection = await shapeSource.getClusterChildren(clusterId);

onPress(event)

arguments

Name	Type	Required	Description
event	n/a	Yes	undefined