mapbox-gl
Version:
A WebGL interactive maps library
1,951 lines (1,950 loc) • 429 kB
JavaScript
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
typeof define === 'function' && define.amd ? define(['exports'], factory) :
(global = global || self, factory(global.mapboxGlStyleSpecification = {}));
}(this, function (exports) { 'use strict';
var $version = 8;
var $root = {
version: {
required: true,
type: "enum",
values: [
8
],
doc: "Style specification version number. Must be 8.",
example: 8
},
name: {
type: "string",
doc: "A human-readable name for the style.",
example: "Bright"
},
metadata: {
type: "*",
doc: "Arbitrary properties useful to track with the stylesheet, but do not influence rendering. Properties should be prefixed to avoid collisions, like 'mapbox:'."
},
center: {
type: "array",
value: "number",
doc: "Default map center in longitude and latitude. The style center will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
example: [
-73.9749,
40.7736
]
},
zoom: {
type: "number",
doc: "Default zoom level. The style zoom will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
example: 12.5
},
bearing: {
type: "number",
"default": 0,
period: 360,
units: "degrees",
doc: "Default bearing, in degrees. The bearing is the compass direction that is \"up\"; for example, a bearing of 90° orients the map so that east is up. This value will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
example: 29
},
pitch: {
type: "number",
"default": 0,
units: "degrees",
doc: "Default pitch, in degrees. Zero is perpendicular to the surface, for a look straight down at the map, while a greater value like 60 looks ahead towards the horizon. The style pitch will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
example: 50
},
light: {
type: "light",
doc: "The global light source.",
example: {
anchor: "viewport",
color: "white",
intensity: 0.4
}
},
sources: {
required: true,
type: "sources",
doc: "Data source specifications.",
example: {
"mapbox-streets": {
type: "vector",
url: "mapbox://mapbox.mapbox-streets-v6"
}
}
},
sprite: {
type: "string",
doc: "A base URL for retrieving the sprite image and metadata. The extensions `.png`, `.json` and scale factor `@2x.png` will be automatically appended. This property is required if any layer uses the `background-pattern`, `fill-pattern`, `line-pattern`, `fill-extrusion-pattern`, or `icon-image` properties. The URL must be absolute, containing the [scheme, authority and path components](https://en.wikipedia.org/wiki/URL#Syntax).",
example: "mapbox://sprites/mapbox/bright-v8"
},
glyphs: {
type: "string",
doc: "A URL template for loading signed-distance-field glyph sets in PBF format. The URL must include `{fontstack}` and `{range}` tokens. This property is required if any layer uses the `text-field` layout property. The URL must be absolute, containing the [scheme, authority and path components](https://en.wikipedia.org/wiki/URL#Syntax).",
example: "mapbox://fonts/mapbox/{fontstack}/{range}.pbf"
},
transition: {
type: "transition",
doc: "A global transition definition to use as a default across properties, to be used for timing transitions between one value and the next when no property-specific transition is set. Collision-based symbol fading is controlled independently of the style's `transition` property.",
example: {
duration: 300,
delay: 0
}
},
layers: {
required: true,
type: "array",
value: "layer",
doc: "Layers will be drawn in the order of this array.",
example: [
{
id: "water",
source: "mapbox-streets",
"source-layer": "water",
type: "fill",
paint: {
"fill-color": "#00ffff"
}
}
]
}
};
var sources = {
"*": {
type: "source",
doc: "Specification of a data source. For vector and raster sources, either TileJSON or a URL to a TileJSON must be provided. For image and video sources, a URL must be provided. For GeoJSON sources, a URL or inline GeoJSON must be provided."
}
};
var source = [
"source_vector",
"source_raster",
"source_raster_dem",
"source_geojson",
"source_video",
"source_image"
];
var source_vector = {
type: {
required: true,
type: "enum",
values: {
vector: {
doc: "A vector tile source."
}
},
doc: "The type of the source."
},
url: {
type: "string",
doc: "A URL to a TileJSON resource. Supported protocols are `http:`, `https:`, and `mapbox://<mapid>`."
},
tiles: {
type: "array",
value: "string",
doc: "An array of one or more tile source URLs, as in the TileJSON spec."
},
bounds: {
type: "array",
value: "number",
length: 4,
"default": [
-180,
-85.051129,
180,
85.051129
],
doc: "An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`. When this property is included in a source, no tiles outside of the given bounds are requested by Mapbox GL."
},
scheme: {
type: "enum",
values: {
xyz: {
doc: "Slippy map tilenames scheme."
},
tms: {
doc: "OSGeo spec scheme."
}
},
"default": "xyz",
doc: "Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed."
},
minzoom: {
type: "number",
"default": 0,
doc: "Minimum zoom level for which tiles are available, as in the TileJSON spec."
},
maxzoom: {
type: "number",
"default": 22,
doc: "Maximum zoom level for which tiles are available, as in the TileJSON spec. Data from tiles at the maxzoom are used when displaying the map at higher zoom levels."
},
attribution: {
type: "string",
doc: "Contains an attribution to be displayed when the map is shown to a user."
},
"*": {
type: "*",
doc: "Other keys to configure the data source."
}
};
var source_raster = {
type: {
required: true,
type: "enum",
values: {
raster: {
doc: "A raster tile source."
}
},
doc: "The type of the source."
},
url: {
type: "string",
doc: "A URL to a TileJSON resource. Supported protocols are `http:`, `https:`, and `mapbox://<mapid>`."
},
tiles: {
type: "array",
value: "string",
doc: "An array of one or more tile source URLs, as in the TileJSON spec."
},
bounds: {
type: "array",
value: "number",
length: 4,
"default": [
-180,
-85.051129,
180,
85.051129
],
doc: "An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`. When this property is included in a source, no tiles outside of the given bounds are requested by Mapbox GL."
},
minzoom: {
type: "number",
"default": 0,
doc: "Minimum zoom level for which tiles are available, as in the TileJSON spec."
},
maxzoom: {
type: "number",
"default": 22,
doc: "Maximum zoom level for which tiles are available, as in the TileJSON spec. Data from tiles at the maxzoom are used when displaying the map at higher zoom levels."
},
tileSize: {
type: "number",
"default": 512,
units: "pixels",
doc: "The minimum visual size to display tiles for this layer. Only configurable for raster layers."
},
scheme: {
type: "enum",
values: {
xyz: {
doc: "Slippy map tilenames scheme."
},
tms: {
doc: "OSGeo spec scheme."
}
},
"default": "xyz",
doc: "Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed."
},
attribution: {
type: "string",
doc: "Contains an attribution to be displayed when the map is shown to a user."
},
"*": {
type: "*",
doc: "Other keys to configure the data source."
}
};
var source_raster_dem = {
type: {
required: true,
type: "enum",
values: {
"raster-dem": {
doc: "A RGB-encoded raster DEM source"
}
},
doc: "The type of the source."
},
url: {
type: "string",
doc: "A URL to a TileJSON resource. Supported protocols are `http:`, `https:`, and `mapbox://<mapid>`."
},
tiles: {
type: "array",
value: "string",
doc: "An array of one or more tile source URLs, as in the TileJSON spec."
},
bounds: {
type: "array",
value: "number",
length: 4,
"default": [
-180,
-85.051129,
180,
85.051129
],
doc: "An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`. When this property is included in a source, no tiles outside of the given bounds are requested by Mapbox GL."
},
minzoom: {
type: "number",
"default": 0,
doc: "Minimum zoom level for which tiles are available, as in the TileJSON spec."
},
maxzoom: {
type: "number",
"default": 22,
doc: "Maximum zoom level for which tiles are available, as in the TileJSON spec. Data from tiles at the maxzoom are used when displaying the map at higher zoom levels."
},
tileSize: {
type: "number",
"default": 512,
units: "pixels",
doc: "The minimum visual size to display tiles for this layer. Only configurable for raster layers."
},
attribution: {
type: "string",
doc: "Contains an attribution to be displayed when the map is shown to a user."
},
encoding: {
type: "enum",
values: {
terrarium: {
doc: "Terrarium format PNG tiles. See https://aws.amazon.com/es/public-datasets/terrain/ for more info."
},
mapbox: {
doc: "Mapbox Terrain RGB tiles. See https://www.mapbox.com/help/access-elevation-data/#mapbox-terrain-rgb for more info."
}
},
"default": "mapbox",
doc: "The encoding used by this source. Mapbox Terrain RGB is used by default"
},
"*": {
type: "*",
doc: "Other keys to configure the data source."
}
};
var source_geojson = {
type: {
required: true,
type: "enum",
values: {
geojson: {
doc: "A GeoJSON data source."
}
},
doc: "The data type of the GeoJSON source."
},
data: {
type: "*",
doc: "A URL to a GeoJSON file, or inline GeoJSON."
},
maxzoom: {
type: "number",
"default": 18,
doc: "Maximum zoom level at which to create vector tiles (higher means greater detail at high zoom levels)."
},
attribution: {
type: "string",
doc: "Contains an attribution to be displayed when the map is shown to a user."
},
buffer: {
type: "number",
"default": 128,
maximum: 512,
minimum: 0,
doc: "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."
},
tolerance: {
type: "number",
"default": 0.375,
doc: "Douglas-Peucker simplification tolerance (higher means simpler geometries and faster performance)."
},
cluster: {
type: "boolean",
"default": false,
doc: "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:\n * `cluster` Is `true` if the point is a cluster \n * `cluster_id` A unqiue id for the cluster to be used in conjunction with the [cluster inspection methods](https://www.mapbox.com/mapbox-gl-js/api/#geojsonsource#getclusterexpansionzoom)\n * `point_count` Number of original points grouped into this cluster\n * `point_count_abbreviated` An abbreviated point count"
},
clusterRadius: {
type: "number",
"default": 50,
minimum: 0,
doc: "Radius of each cluster if clustering is enabled. A value of 512 indicates a radius equal to the width of a tile."
},
clusterMaxZoom: {
type: "number",
doc: "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)."
},
clusterProperties: {
type: "*",
doc: "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.\n\nExample: `{\"sum\": [\"+\", [\"get\", \"scalerank\"]]}`.\n\nFor more advanced use cases, in place of `operator`, you can use a custom reduce expression that references a special `[\"accumulated\"]` value, e.g.:\n`{\"sum\": [[\"+\", [\"accumulated\"], [\"get\", \"sum\"]], [\"get\", \"scalerank\"]]}`"
},
lineMetrics: {
type: "boolean",
"default": false,
doc: "Whether to calculate line distance metrics. This is required for line layers that specify `line-gradient` values."
},
generateId: {
type: "boolean",
"default": false,
doc: "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."
}
};
var source_video = {
type: {
required: true,
type: "enum",
values: {
video: {
doc: "A video data source."
}
},
doc: "The data type of the video source."
},
urls: {
required: true,
type: "array",
value: "string",
doc: "URLs to video content in order of preferred format."
},
coordinates: {
required: true,
doc: "Corners of video specified in longitude, latitude pairs.",
type: "array",
length: 4,
value: {
type: "array",
length: 2,
value: "number",
doc: "A single longitude, latitude pair."
}
}
};
var source_image = {
type: {
required: true,
type: "enum",
values: {
image: {
doc: "An image data source."
}
},
doc: "The data type of the image source."
},
url: {
required: true,
type: "string",
doc: "URL that points to an image."
},
coordinates: {
required: true,
doc: "Corners of image specified in longitude, latitude pairs.",
type: "array",
length: 4,
value: {
type: "array",
length: 2,
value: "number",
doc: "A single longitude, latitude pair."
}
}
};
var layer = {
id: {
type: "string",
doc: "Unique layer name.",
required: true
},
type: {
type: "enum",
values: {
fill: {
doc: "A filled polygon with an optional stroked border.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
}
}
},
line: {
doc: "A stroked line.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
}
}
},
symbol: {
doc: "An icon or a text label.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
}
}
},
circle: {
doc: "A filled circle.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
}
}
},
heatmap: {
doc: "A heatmap.",
"sdk-support": {
"basic functionality": {
js: "0.41.0",
android: "6.0.0",
ios: "4.0.0",
macos: "0.7.0"
}
}
},
"fill-extrusion": {
doc: "An extruded (3D) polygon.",
"sdk-support": {
"basic functionality": {
js: "0.27.0",
android: "5.1.0",
ios: "3.6.0",
macos: "0.5.0"
}
}
},
raster: {
doc: "Raster map textures such as satellite imagery.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
}
}
},
hillshade: {
doc: "Client-side hillshading visualization based on DEM data. Currently, the implementation only supports Mapbox Terrain RGB and Mapzen Terrarium tiles.",
"sdk-support": {
"basic functionality": {
js: "0.43.0",
android: "6.0.0",
ios: "4.0.0",
macos: "0.7.0"
}
}
},
background: {
doc: "The background color or pattern of the map.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
}
}
}
},
doc: "Rendering type of this layer.",
required: true
},
metadata: {
type: "*",
doc: "Arbitrary properties useful to track with the layer, but do not influence rendering. Properties should be prefixed to avoid collisions, like 'mapbox:'."
},
source: {
type: "string",
doc: "Name of a source description to be used for this layer. Required for all layer types except `background`."
},
"source-layer": {
type: "string",
doc: "Layer to use from a vector tile source. Required for vector tile sources; prohibited for all other source types, including GeoJSON sources."
},
minzoom: {
type: "number",
minimum: 0,
maximum: 24,
doc: "The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden."
},
maxzoom: {
type: "number",
minimum: 0,
maximum: 24,
doc: "The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden."
},
filter: {
type: "filter",
doc: "A expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The `feature-state` expression is not supported in filter expressions."
},
layout: {
type: "layout",
doc: "Layout properties for the layer."
},
paint: {
type: "paint",
doc: "Default paint properties for this layer."
}
};
var layout = [
"layout_fill",
"layout_line",
"layout_circle",
"layout_heatmap",
"layout_fill-extrusion",
"layout_symbol",
"layout_raster",
"layout_hillshade",
"layout_background"
];
var layout_background = {
visibility: {
type: "enum",
values: {
visible: {
doc: "The layer is shown."
},
none: {
doc: "The layer is not shown."
}
},
"default": "visible",
doc: "Whether this layer is displayed.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
}
},
"property-type": "constant"
}
};
var layout_fill = {
"fill-sort-key": {
type: "number",
doc: "Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.",
"sdk-support": {
js: "1.2.0"
},
expression: {
interpolated: false,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
visibility: {
type: "enum",
values: {
visible: {
doc: "The layer is shown."
},
none: {
doc: "The layer is not shown."
}
},
"default": "visible",
doc: "Whether this layer is displayed.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
}
},
"property-type": "constant"
}
};
var layout_circle = {
"circle-sort-key": {
type: "number",
doc: "Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.",
"sdk-support": {
js: "1.2.0"
},
expression: {
interpolated: false,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
visibility: {
type: "enum",
values: {
visible: {
doc: "The layer is shown."
},
none: {
doc: "The layer is not shown."
}
},
"default": "visible",
doc: "Whether this layer is displayed.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
}
},
"property-type": "constant"
}
};
var layout_heatmap = {
visibility: {
type: "enum",
values: {
visible: {
doc: "The layer is shown."
},
none: {
doc: "The layer is not shown."
}
},
"default": "visible",
doc: "Whether this layer is displayed.",
"sdk-support": {
"basic functionality": {
js: "0.41.0",
android: "6.0.0",
ios: "4.0.0",
macos: "0.7.0"
}
},
"property-type": "constant"
}
};
var layout_line = {
"line-cap": {
type: "enum",
values: {
butt: {
doc: "A cap with a squared-off end which is drawn to the exact endpoint of the line."
},
round: {
doc: "A cap with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line."
},
square: {
doc: "A cap with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width."
}
},
"default": "butt",
doc: "The display of line endings.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: false,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"line-join": {
type: "enum",
values: {
bevel: {
doc: "A join with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width."
},
round: {
doc: "A join with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line."
},
miter: {
doc: "A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet."
}
},
"default": "miter",
doc: "The display of lines when joining.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
js: "0.40.0",
android: "5.2.0",
ios: "3.7.0",
macos: "0.6.0"
}
},
expression: {
interpolated: false,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"line-miter-limit": {
type: "number",
"default": 2,
doc: "Used to automatically convert miter joins to bevel joins for sharp angles.",
requires: [
{
"line-join": "miter"
}
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: true,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"line-round-limit": {
type: "number",
"default": 1.05,
doc: "Used to automatically convert round joins to miter joins for shallow angles.",
requires: [
{
"line-join": "round"
}
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: true,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"line-sort-key": {
type: "number",
doc: "Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.",
"sdk-support": {
js: "1.2.0"
},
expression: {
interpolated: false,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
visibility: {
type: "enum",
values: {
visible: {
doc: "The layer is shown."
},
none: {
doc: "The layer is not shown."
}
},
"default": "visible",
doc: "Whether this layer is displayed.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
}
},
"property-type": "constant"
}
};
var layout_symbol = {
"symbol-placement": {
type: "enum",
values: {
point: {
doc: "The label is placed at the point where the geometry is located."
},
line: {
doc: "The label is placed along the line of the geometry. Can only be used on `LineString` and `Polygon` geometries."
},
"line-center": {
doc: "The label is placed at the center of the line of the geometry. Can only be used on `LineString` and `Polygon` geometries. Note that a single feature in a vector tile may contain multiple line geometries."
}
},
"default": "point",
doc: "Label placement relative to its geometry.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"`line-center` value": {
js: "0.47.0",
android: "6.4.0",
ios: "4.3.0",
macos: "0.10.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: false,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"symbol-spacing": {
type: "number",
"default": 250,
minimum: 1,
units: "pixels",
doc: "Distance between two symbol anchors.",
requires: [
{
"symbol-placement": "line"
}
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: true,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"symbol-avoid-edges": {
type: "boolean",
"default": false,
doc: "If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: false,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"symbol-sort-key": {
type: "number",
doc: "Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key when they overlap. Features with a lower sort key will have priority over other features when doing placement.",
"sdk-support": {
"basic functionality": {
js: "0.53.0",
android: "7.4.0",
ios: "4.11.0",
macos: "0.14.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: false,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"symbol-z-order": {
type: "enum",
values: {
auto: {
doc: "If `symbol-sort-key` is set, sort based on that. Otherwise sort symbols by their y-position relative to the viewport."
},
"viewport-y": {
doc: "Symbols will be sorted by their y-position relative to the viewport."
},
source: {
doc: "Symbols will be rendered in the same order as the source data with no sorting applied."
}
},
"default": "auto",
doc: "Controls the order in which overlapping symbols in the same layer are rendered",
"sdk-support": {
"basic functionality": {
js: "0.49.0",
android: "6.6.0",
ios: "4.5.0",
macos: "0.12.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: false,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"icon-allow-overlap": {
type: "boolean",
"default": false,
doc: "If true, the icon will be visible even if it collides with other previously drawn symbols.",
requires: [
"icon-image"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: false,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"icon-ignore-placement": {
type: "boolean",
"default": false,
doc: "If true, other symbols can be visible even if they collide with the icon.",
requires: [
"icon-image"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: false,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"icon-optional": {
type: "boolean",
"default": false,
doc: "If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.",
requires: [
"icon-image",
"text-field"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: false,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"icon-rotation-alignment": {
type: "enum",
values: {
map: {
doc: "When `symbol-placement` is set to `point`, aligns icons east-west. When `symbol-placement` is set to `line` or `line-center`, aligns icon x-axes with the line."
},
viewport: {
doc: "Produces icons whose x-axes are aligned with the x-axis of the viewport, regardless of the value of `symbol-placement`."
},
auto: {
doc: "When `symbol-placement` is set to `point`, this is equivalent to `viewport`. When `symbol-placement` is set to `line` or `line-center`, this is equivalent to `map`."
}
},
"default": "auto",
doc: "In combination with `symbol-placement`, determines the rotation behavior of icons.",
requires: [
"icon-image"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"`auto` value": {
js: "0.25.0",
android: "4.2.0",
ios: "3.4.0",
macos: "0.3.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: false,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"icon-size": {
type: "number",
"default": 1,
minimum: 0,
units: "factor of the original icon size",
doc: "Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by `icon-size`. 1 is the original size; 3 triples the size of the image.",
requires: [
"icon-image"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
js: "0.35.0",
android: "5.1.0",
ios: "3.6.0",
macos: "0.5.0"
}
},
expression: {
interpolated: true,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"icon-text-fit": {
type: "enum",
values: {
none: {
doc: "The icon is displayed at its intrinsic aspect ratio."
},
width: {
doc: "The icon is scaled in the x-dimension to fit the width of the text."
},
height: {
doc: "The icon is scaled in the y-dimension to fit the height of the text."
},
both: {
doc: "The icon is scaled in both x- and y-dimensions."
}
},
"default": "none",
doc: "Scales the icon to fit around the associated text.",
requires: [
"icon-image",
"text-field"
],
"sdk-support": {
"basic functionality": {
js: "0.21.0",
android: "4.2.0",
ios: "3.4.0",
macos: "0.2.1"
},
"data-driven styling": {
}
},
expression: {
interpolated: false,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"icon-text-fit-padding": {
type: "array",
value: "number",
length: 4,
"default": [
0,
0,
0,
0
],
units: "pixels",
doc: "Size of the additional area added to dimensions determined by `icon-text-fit`, in clockwise order: top, right, bottom, left.",
requires: [
"icon-image",
"text-field",
{
"icon-text-fit": [
"both",
"width",
"height"
]
}
],
"sdk-support": {
"basic functionality": {
js: "0.21.0",
android: "4.2.0",
ios: "3.4.0",
macos: "0.2.1"
},
"data-driven styling": {
}
},
expression: {
interpolated: true,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"icon-image": {
type: "string",
doc: "Name of image in sprite to use for drawing an image background.",
tokens: true,
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
js: "0.35.0",
android: "5.1.0",
ios: "3.6.0",
macos: "0.5.0"
}
},
expression: {
interpolated: false,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"icon-rotate": {
type: "number",
"default": 0,
period: 360,
units: "degrees",
doc: "Rotates the icon clockwise.",
requires: [
"icon-image"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
js: "0.21.0",
android: "5.0.0",
ios: "3.5.0",
macos: "0.4.0"
}
},
expression: {
interpolated: true,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"icon-padding": {
type: "number",
"default": 2,
minimum: 0,
units: "pixels",
doc: "Size of the additional area around the icon bounding box used for detecting symbol collisions.",
requires: [
"icon-image"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: true,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"icon-keep-upright": {
type: "boolean",
"default": false,
doc: "If true, the icon may be flipped to prevent it from being rendered upside-down.",
requires: [
"icon-image",
{
"icon-rotation-alignment": "map"
},
{
"symbol-placement": [
"line",
"line-center"
]
}
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: false,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"icon-offset": {
type: "array",
value: "number",
length: 2,
"default": [
0,
0
],
doc: "Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. Each component is multiplied by the value of `icon-size` to obtain the final offset in pixels. When combined with `icon-rotate` the offset will be as if the rotated direction was up.",
requires: [
"icon-image"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
js: "0.29.0",
android: "5.0.0",
ios: "3.5.0",
macos: "0.4.0"
}
},
expression: {
interpolated: true,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"icon-anchor": {
type: "enum",
values: {
center: {
doc: "The center of the icon is placed closest to the anchor."
},
left: {
doc: "The left side of the icon is placed closest to the anchor."
},
right: {
doc: "The right side of the icon is placed closest to the anchor."
},
top: {
doc: "The top of the icon is placed closest to the anchor."
},
bottom: {
doc: "The bottom of the icon is placed closest to the anchor."
},
"top-left": {
doc: "The top left corner of the icon is placed closest to the anchor."
},
"top-right": {
doc: "The top right corner of the icon is placed closest to the anchor."
},
"bottom-left": {
doc: "The bottom left corner of the icon is placed closest to the anchor."
},
"bottom-right": {
doc: "The bottom right corner of the icon is placed closest to the anchor."
}
},
"default": "center",
doc: "Part of the icon placed closest to the anchor.",
requires: [
"icon-image"
],
"sdk-support": {
"basic functionality": {
js: "0.40.0",
android: "5.2.0",
ios: "3.7.0",
macos: "0.6.0"
},
"data-driven styling": {
js: "0.40.0",
android: "5.2.0",
ios: "3.7.0",
macos: "0.6.0"
}
},
expression: {
interpolated: false,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"icon-pitch-alignment": {
type: "enum",
values: {
map: {
doc: "The icon is aligned to the plane of the map."
},
viewport: {
doc: "The icon is aligned to the plane of the viewport."
},
auto: {
doc: "Automatically matches the value of `icon-rotation-alignment`."
}
},
"default": "auto",
doc: "Orientation of icon when map is pitched.",
requires: [
"icon-image"
],
"sdk-support": {
"basic functionality": {
js: "0.39.0",
android: "5.2.0",
ios: "3.7.0",
macos: "0.6.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: false,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"text-pitch-alignment": {
type: "enum",
values: {
map: {
doc: "The text is aligned to the plane of the map."
},
viewport: {
doc: "The text is aligned to the plane of the viewport."
},
auto: {
doc: "Automatically matches the value of `text-rotation-alignment`."
}
},
"default": "auto",
doc: "Orientation of text when map is pitched.",
requires: [
"text-field"
],
"sdk-support": {
"basic functionality": {
js: "0.21.0",
android: "4.2.0",
ios: "3.4.0",
macos: "0.2.1"
},
"`auto` value": {
js: "0.25.0",
android: "4.2.0",
ios: "3.4.0",
macos: "0.3.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: false,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"text-rotation-alignment": {
type: "enum",
values: {
map: {
doc: "When `symbol-placement` is set to `point`, aligns text east-west. When `symbol-placement` is set to `line` or `line-center`, aligns text x-axes with the line."
},
viewport: {
doc: "Produces glyphs whose x-axes are aligned with the x-axis of the viewport, regardless of the value of `symbol-placement`."
},
auto: {
doc: "When `symbol-placement` is set to `point`, this is equivalent to `viewport`. When `symbol-placement` is set to `line` or `line-center`, this is equivalent to `map`."
}
},
"default": "auto",
doc: "In combination with `symbol-placement`, determines the rotation behavior of the individual glyphs forming the text.",
requires: [
"text-field"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"`auto` value": {
js: "0.25.0",
android: "4.2.0",
ios: "3.4.0",
macos: "0.3.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: false,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"text-field": {
type: "formatted",
"default": "",
tokens: true,
doc: "Value to use for a text label. If a plain `string` is provided, it will be treated as a `formatted` with default/inherited formatting options.",
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
js: "0.33.0",
android: "5.0.0",
ios: "3.5.0",
macos: "0.4.0"
}
},
expression: {
interpolated: false,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"text-font": {
type: "array",
value: "string",
"default": [
"Open Sans Regular",
"Arial Unicode MS Regular"
],
doc: "Font stack to use for displaying text.",
requires: [
"text-field"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
js: "0.43.0",
android: "6.0.0",
ios: "4.0.0",
macos: "0.7.0"
}
},
expression: {
interpolated: false,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"text-size": {
type: "number",
"default": 16,
minimum: 0,
units: "pixels",
doc: "Font size.",
requires: [
"text-field"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
js: "0.35.0",
android: "5.1.0",
ios: "3.6.0",
macos: "0.5.0"
}
},
expression: {
interpolated: true,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"text-max-width": {
type: "number",
"default": 10,
minimum: 0,
units: "ems",
doc: "The maximum line width for text wrapping.",
requires: [
"text-field"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
js: "0.40.0",
android: "5.2.0",
ios: "3.7.0",
macos: "0.6.0"
}
},
expression: {
interpolated: true,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"text-line-height": {
type: "number",
"default": 1.2,
units: "ems",
doc: "Text leading value for multi-line text.",
requires: [
"text-field"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
}
},
expression: {
interpolated: true,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"text-letter-spacing": {
type: "number",
"default": 0,
units: "ems",
doc: "Text tracking amount.",
requires: [
"text-field"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
js: "0.40.0",
android: "5.2.0",
ios: "3.7.0",
macos: "0.6.0"
}
},
expression: {
interpolated: true,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"text-justify": {
type: "enum",
values: {
auto: {
doc: "The text is aligned towards the anchor position."
},
left: {
doc: "The text is aligned to the left."
},
center: {
doc: "The text is centered."
},
right: {
doc: "The text is aligned to the right."
}
},
"default": "center",
doc: "Text justification options.",
requires: [
"text-field"
],
"sdk-support": {
"basic functionality": {
js: "0.10.0",
android: "2.0.1",
ios: "2.0.0",
macos: "0.1.0"
},
"data-driven styling": {
js: "0.39.0",
android: "5.2.0",
ios: "3.7.0",
macos: "0.6.0"
},
auto: {
js: "0.54.0",
android: "7.4.0",
ios: "4.10.0",
macos: "0.14.0"
}
},
expression: {
interpolated: false,
parameters: [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"text-radial-offset": {
type: "number",
units: "ems",
"default": 0,
doc: "Radial offset of text, in the direction of the symbol's anchor. Useful in combination with `text-variable-anchor`, which doesn't support the two-dimensional `text-offset`.",
"sdk-support": {
"basic functionality": {
js: "0.54.0",
android: "7.4.0",
ios: "4.10.0",
macos: "0.14.0"
},
"data-driven styling": {
js: "0.54.0",
android: "7.4.0",
ios: "4.10.0",
macos: "0.14.0"
}
},
requires: [
"text-field"
],
"property-type": "data-driven",
expression: {
interpolated: true,
parameters: [
"zoom",
"feature"
]
}
},
"text-variable-anchor": {
type: "array",
value: "enum",
values: {
center: {
doc: "The center of the text is placed closest to the anchor."
},
left: {
doc: "The left side of the text is placed closest to the anchor."
},
right: {
doc: "The right side of the text is placed closest to the anchor."
},
top: {
doc: "The top of the text is placed closest to the anchor."
},
bottom: {
doc: "The bottom of the text is placed closest to the anchor."
},
"top-left": {
doc: "The top left corner of the text is placed closest to the anchor."
},
"top-right": {
doc: "The top right corner of the text is placed closest to the anchor."
},
"bottom-left": {
doc: "The bottom left corner of the text is placed closest to the anchor."
},
"bottom-right": {
doc: "The bottom right corner of the text is placed closest to the anchor."
}
},
requires: [
"text-field",
{
"symbol-placement": [
"point"
]
}
],
doc: "To increase the chance of placing high-priority labels on the map, you can provide an array of `text-anchor` locations: the render will attempt to place the label at each location, in order, before moving onto the next label. Use `text-justify: auto` to choose justification based on anchor position. To apply an offset, use the `text-radial-offset` instead of the two-dimensional `text-offset`.",
"sdk-support": {
"basic functionality": {
js: "0.54.0",
android: "7.4.0",
ios: "4.10.0",
macos: "0.14.0"
},
"data-driven styling": {
js: "Not yet supported",
android: "Not yet supported",
ios: "Not yet supported",
macos: "Not yet supported"
}
},
expression: {
interpolated: false,
parameters: [
"zoom"
]
},
"property-type": "data-constant"
},
"text-anchor": {
type: "enum",
values: {
center: {
doc: "The center of the text is placed closest to the anchor."
},
lef