GeoJsonSource

Builder for GeoJsonSource.

Static variables and methods.

Add the GeoJsonSource to the Style.

Sets GeoJson data property as a String. value could be an URL to a GeoJSON file, or an inline GeoJSON.

Add a Feature to the GeojsonSource. The data will be scheduled and applied on a worker thread.

Add a Feature Collection to the GeojsonSource. The data will be scheduled and applied on a worker thread.

Add a Geometry to the GeojsonSource. The data will be scheduled and applied on a worker thread.

When loading a map, if PrefetchZoomDelta is set to any number greater than 0, the map will first request a tile at zoom level lower than zoom - delta, but so that the zoom level is multiple of delta, in an attempt to display a full map at lower resolution as quick as possible. It will get clamped at the tile source minimum zoom. Default value: 4.

This property defines a source-specific resource budget, either in tile units or in megabytes. Whenever the tile cache goes over the defined limit, the least recently used tile will be evicted from the in-memory cache. Note that the current implementation does not take into account resources allocated by the visible tiles.

Returns a human readable string that includes the cached properties of the source.

Contains an attribution to be displayed when the map is shown to a user.

When set to true, the maxZoom property is ignored and is instead calculated automatically based on the largest bounding box from the geoJSON features. This resolves rendering artifacts for features that use wide blur (e.g. fill extrusion ground flood light or circle layer) and would bring performance improvement on lower zoom levels, especially for geoJSON sources that update data frequently. However, it can lead to flickering and precision loss on zoom levels above 19. Default value: false.

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. Default value: 128. Value range: 0, 512

If the data is a collection of point features, setting this to true clusters the points by radius into groups. Cluster groups become new Point features in the source with additional properties:

Max zoom on which to cluster points if clustering is enabled. Defaults to one zoom less than maxzoom (so that last zoom features are not clustered). Clusters are re-evaluated at integer zoom levels so setting clusterMaxZoom to 14 means the clusters will be displayed until z15.

Minimum number of points necessary to form a cluster if clustering is enabled. Defaults to 2.

An object defining custom properties on the generated clusters if clustering is enabled, aggregating values from clustered points. Has the form {"property_name": [operator, map_expression]}. operator is any expression function that accepts at least 2 operands (e.g. "+" or "max") — it accumulates the property value from clusters/points the cluster contains; map_expression produces the value of a single point.

Radius of each cluster if clustering is enabled. A value of 512 indicates a radius equal to the width of a tile. Default value: 50. Minimum value: 0.

A URL to a GeoJSON file, or inline GeoJSON.

Whether to generate ids for the GeoJSON features. When enabled, the feature.id property will be auto assigned based on its index in the features array, over-writing any previous values. Default value: false.

Whether to calculate line distance metrics. This is required for line layers that specify line-gradient values. Default value: false.

Maximum zoom level at which to create vector tiles (higher means greater detail at high zoom levels). Default value: 18.

When loading a map, if PrefetchZoomDelta is set to any number greater than 0, the map will first request a tile at zoom level lower than zoom - delta, but so that the zoom level is multiple of delta, in an attempt to display a full map at lower resolution as quick as possible. It will get clamped at the tile source minimum zoom. Default value: 4.

A property to use as a feature id (for feature state). Either a property name, or an object of the form {<sourceLayer>: <propertyName>}.

The ID of the Source.

This property defines a source-specific resource budget, either in tile units or in megabytes. Whenever the tile cache goes over the defined limit, the least recently used tile will be evicted from the in-memory cache. Note that the current implementation does not take into account resources allocated by the visible tiles.

Douglas-Peucker simplification tolerance (higher means simpler geometries and faster performance). Default value: 0.375.

Add additional features to a GeoJSON style source. The data will be scheduled and applied on a worker thread.

Remove features from a GeoJSON style source. The data will be scheduled and applied on a worker thread.

Update existing features in a GeoJSON style source. The data will be scheduled and applied on a worker thread.