See also
Constructors
Types
Functions
Properties
Contains an attribution to be displayed when the map is shown to a user.
Contains an attribution to be displayed when the map is shown to a user.
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.
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:
clusterIstrueif the point is a clustercluster_idA unqiue id for the cluster to be used in conjunction with the cluster inspection methodspoint_countNumber of original points grouped into this clusterpoint_count_abbreviatedAn abbreviated point count
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:
clusterIstrueif the point is a clustercluster_idA unqiue id for the cluster to be used in conjunction with the cluster inspection methodspoint_countNumber of original points grouped into this clusterpoint_count_abbreviatedAn abbreviated point count
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.
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.
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.
Example: {"sum": ["+", ["get", "scalerank"]]}.
For more advanced use cases, in place of operator, you can use a custom reduce expression that references a special ["accumulated"] value, e.g.: {"sum": [["+", ["accumulated"], ["get", "sum"]], ["get", "scalerank"]]}
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.
Example: {"sum": ["+", ["get", "scalerank"]]}.
For more advanced use cases, in place of operator, you can use a custom reduce expression that references a special ["accumulated"] value, e.g.: {"sum": [["+", ["accumulated"], ["get", "sum"]], ["get", "scalerank"]]}
Radius of each cluster if clustering is enabled. A value of 512 indicates a radius equal to the width of a tile.
Radius of each cluster if clustering is enabled. A value of 512 indicates a radius equal to the width of a tile.
A URL to a GeoJSON file, or inline GeoJSON.
Note: Getter for plain Geojson string data is not supported due to performance consideration.
Whether to calculate line distance metrics. This is required for line layers that specify line-gradient values.
Whether to calculate line distance metrics. This is required for line layers that specify line-gradient values.
Maximum zoom level at which to create vector tiles (higher means greater detail at high zoom levels).
When loading a map, if PrefetchZoomDelta is set to any number greater than 0, the map will first request a tile for zoom - delta in a attempt to display a full map at lower resolution as quick as possible. It will get clamped at the tile source minimum zoom. The default delta is 4.
When loading a map, if PrefetchZoomDelta is set to any number greater than 0, the map will first request a tile for zoom - delta in a attempt to display a full map at lower resolution as quick as possible. It will get clamped at the tile source minimum zoom. The default delta is 4.
Douglas-Peucker simplification tolerance (higher means simpler geometries and faster performance).