{
"$version": 8,
"$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 'maplibre:'.",
"example": {
"styleeditor:slimmode": true,
"styleeditor:comment": "Style generated 1677776383",
"styleeditor:version": "3.14.159265",
"example:object": { "String": "one", "Number": 2, "Boolean": false }
}
},
"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
]
},
"centerAltitude": {
"type": "number",
"doc": "Default map center altitude in meters above sea level. The style center altitude defines the altitude where the camera is looking at and will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
"example": 123.4,
"sdk-support": {
"basic functionality": {
"js": "5.0.0",
"android": "https://github.com/maplibre/maplibre-native/issues/2980",
"ios": "https://github.com/maplibre/maplibre-native/issues/2980"
}
}
},
"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,
"sdk-support": {
"0-60 degrees": {
"js": "0.8.0",
"android": "1.0.0",
"ios": "1.0.0"
},
"0-85 degrees": {
"js": "2.0.0",
"android": "https://github.com/maplibre/maplibre-native/issues/1909",
"ios": "https://github.com/maplibre/maplibre-native/issues/1909"
},
"0-180 degrees": {
"js": "5.0.0",
"android": "https://github.com/maplibre/maplibre-native/issues/1909",
"ios": "https://github.com/maplibre/maplibre-native/issues/1909"
}
}
},
"roll": {
"type": "number",
"default": 0,
"units": "degrees",
"doc": "Default roll, in degrees. The roll angle is measured counterclockwise about the camera boresight. The style roll will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
"example": 45,
"sdk-support": {
"basic functionality": {
"js": "5.0.0",
"android": "https://github.com/maplibre/maplibre-native/issues/2941",
"ios": "https://github.com/maplibre/maplibre-native/issues/2941"
}
}
},
"state": {
"type": "state",
"default": {},
"doc": "An object used to define default values when using the [`global-state`](https://maplibre.org/maplibre-style-spec/expressions/#global-state) expression.",
"example": {
"chargerType": {
"default": ["CCS", "CHAdeMO", "Type2"]
},
"minPreferredChargingSpeed": {
"default": 50
}
},
"sdk-support": {
"basic functionality": {
"js": "5.6.0",
"android": "https://github.com/maplibre/maplibre-native/issues/3302",
"ios": "https://github.com/maplibre/maplibre-native/issues/3302"
}
}
},
"light": {
"type": "light",
"doc": "The global light source.",
"example": {
"anchor": "viewport",
"color": "white",
"intensity": 0.4
}
},
"sky": {
"type": "sky",
"doc": "The map's sky configuration. **Note:** this definition is still experimental and is under development in maplibre-gl-js.",
"example": {
"sky-color": "#199EF3",
"sky-horizon-blend": 0.5,
"horizon-color": "#ffffff",
"horizon-fog-blend": 0.5,
"fog-color": "#0000ff",
"fog-ground-blend": 0.5,
"atmosphere-blend": ["interpolate",
["linear"],
["zoom"],
0,1,
10,1,
12,0
]
}
},
"projection": {
"type": "projection",
"doc": "The projection configuration",
"example": {
"type": [
"interpolate",
["linear"],
["zoom"],
10, "vertical-perspective",
12, "mercator"
]
}
},
"terrain": {
"type": "terrain",
"doc": "The terrain configuration.",
"example": {
"source": "raster-dem-source",
"exaggeration": 0.5
}
},
"sources": {
"required": true,
"type": "sources",
"doc": "Sources state which data the map should display. Specify the type of source with the `type` property. Adding a source isn't enough to make data appear on the map because sources don't contain styling details like color or width. Layers refer to a source and give it a visual representation. This makes it possible to style the same source in different ways, like differentiating between types of roads in a highways layer.\n\nTiled sources (vector and raster) must specify their details according to the [TileJSON specification](https://github.com/mapbox/tilejson-spec).",
"example": {
"maplibre-demotiles": {
"type": "vector",
"url": "https://demotiles.maplibre.org/tiles/tiles.json"
},
"maplibre-tilejson": {
"type": "vector",
"url": "http://api.example.com/tilejson.json"
},
"maplibre-streets": {
"type": "vector",
"tiles": [
"http://a.example.com/tiles/{z}/{x}/{y}.pbf",
"http://b.example.com/tiles/{z}/{x}/{y}.pbf"
],
"maxzoom": 14
},
"wms-imagery": {
"type": "raster",
"tiles": [
"http://a.example.com/wms?bbox={bbox-epsg-3857}&format=image/png&service=WMS&version=1.1.1&request=GetMap&srs=EPSG:3857&width=256&height=256&layers=example"
],
"tileSize": 256
}
}
},
"sprite": {
"type": "sprite",
"doc": "An array of `{id: 'my-sprite', url: 'https://example.com/sprite'}` objects. Each object should represent a unique URL to load a sprite from and and a unique ID to use as a prefix when referencing images from that sprite (i.e. 'my-sprite:image'). All the URLs are internally extended to load both .json and .png files. If the `id` field is equal to 'default', the prefix is omitted (just 'image' instead of 'default:image'). All the IDs and URLs must be unique. For backwards compatibility, instead of an array, one can also provide a single string that represent a URL to load the sprite from. The images in this case won't be prefixed.",
"example": "https://demotiles.maplibre.org/styles/osm-bright-gl-style/sprite"
},
"glyphs": {
"type": "string",
"doc": "A URL template for loading signed-distance-field glyph sets in PBF format.\n\nIf this property is set, any text in the `text-field` layout property is displayed in the font stack named by the `text-font` layout property based on glyphs located at the URL specified by this property. Otherwise, font faces will be determined by the `text-font` property based on the local environment.\n\nThe URL must include:\n\n - `{fontstack}` - When requesting glyphs, this token is replaced with a comma separated list of fonts from a font stack specified in the `text-font` property of a symbol layer. \n\n - `{range}` - When requesting glyphs, this token is replaced with a range of 256 Unicode code points. For example, to load glyphs for the Unicode Basic Latin and Basic Latin-1 Supplement blocks, the range would be 0-255. The actual ranges that are loaded are determined at runtime based on what text needs to be displayed.\n\nThe URL must be absolute, containing the [scheme, authority and path components](https://en.wikipedia.org/wiki/URL#Syntax).",
"example": "https://demotiles.maplibre.org/font/{fontstack}/{range}.pbf",
"sdk-support": {
"basic functionality": {
"js": "0.0.16",
"android": "0.1.1",
"ios": "0.1.0"
},
"omit to use local fonts": {
"js": "https://github.com/maplibre/maplibre-gl-js/issues/3302",
"android": "https://github.com/maplibre/maplibre-native/issues/165",
"ios": "https://github.com/maplibre/maplibre-native/issues/165"
}
}
},
"font-faces": {
"type": "array",
"value": "fontFaces",
"doc": "The `font-faces` property can be used to specify what font files to use for rendering text. Font faces contain information needed to render complex texts such as [Devanagari](https://en.wikipedia.org/wiki/Devanagari), [Khmer](https://en.wikipedia.org/wiki/Khmer_script) among many others.Unicode range
The optional `unicode-range` property can be used to only use a particular font file for characters within the specified unicode range(s). Its value should be an array of strings, each indicating a start and end of a unicode range, similar to the [CSS descriptor with the same name](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/unicode-range). This allows specifying multiple non-consecutive unicode ranges. When not specified, the default value is `U+0-10FFFF`, meaning the font file will be used for all unicode characters.\n\nRefer to the [Unicode Character Code Charts](https://www.unicode.org/charts/) to see ranges for scripts supported by Unicode. To see what unicode code-points are available in a font, use a tool like [FontDrop](https://fontdrop.info/).\n\nFont Resolution
For every name in a symbol layer’s [`text-font`](./layers.md/#text-font) array, characters are matched if they are covered one of the by the font files in the corresponding entry of the `font-faces` map. Any still-unmatched characters then fall back to the [`glyphs`](./glyphs.md) URL if provided.\n\nSupported Fonts
What type of fonts are supported is implementation-defined. Unsupported fonts are ignored.",
"example": {
"Noto Sans Regular": [{
"url": "https://cdn.jsdelivr.net/gh/notofonts/notofonts.github.io/fonts/NotoSansKhmer/hinted/ttf/NotoSansKhmer-Regular.ttf",
"unicode-range": ["U+1780-17FF"]
},
{
"url": "https://cdn.jsdelivr.net/gh/notofonts/notofonts.github.io/fonts/NotoSansDevanagari/hinted/ttf/NotoSansDevanagari-Regular.ttf",
"unicode-range": ["U+0900-097F"]
},
{
"url": "https://cdn.jsdelivr.net/gh/notofonts/notofonts.github.io/fonts/NotoSansMyanmar/hinted/ttf/NotoSansMyanmar-Regular.ttf",
"unicode-range": ["U+1000-109F"]
},
{
"url": "https://cdn.jsdelivr.net/gh/notofonts/notofonts.github.io/fonts/NotoSansEthiopic/hinted/ttf/NotoSansEthiopic-Regular.ttf",
"unicode-range": ["U+1200-137F"]
}],
"Unifont": "https://ftp.gnu.org/gnu/unifont/unifont-15.0.01/unifont-15.0.01.ttf"
},
"sdk-support": {
"basic functionality": {
"js": "https://github.com/maplibre/maplibre-gl-js/issues/50",
"android": "11.13.0",
"ios": "6.18.0"
}
}
},
"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": "A style's `layers` property lists all the layers available in that style. The type of layer is specified by the `type` property, and must be one of `background`, `fill`, `line`, `symbol`, `raster`, `circle`, `fill-extrusion`, `heatmap`, `hillshade`, `color-relief`.\n\nExcept for layers of the `background` type, each layer needs to refer to a source. Layers take the data that they get from a source, optionally filter features, and then define how those features are styled.",
"example": [
{
"id": "coastline",
"source": "maplibre",
"source-layer": "countries",
"type": "line",
"paint": {
"line-color": "#198EC8"
}
}
]
}
},
"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."
}
},
"source": [
"source_vector",
"source_raster",
"source_raster_dem",
"source_geojson",
"source_video",
"source_image"
],
"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:` and `https:`."
},
"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 MapLibre."
},
"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."
},
"promoteId": {
"type": "promoteId",
"doc": "A property to use as a feature id (for feature state). Either a property name, or an object of the form `{: }`. If specified as a string for a vector tile source, the same property is used across all its source layers."
},
"volatile": {
"type": "boolean",
"default": false,
"doc": "A setting to determine whether a source's tiles are cached locally.",
"sdk-support": {
"basic functionality": {
"android": "9.3.0",
"ios": "5.10.0",
"js": "wontfix"
}
}
},
"*": {
"type": "*",
"doc": "Other keys to configure the data source."
}
},
"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:` and `https:`."
},
"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 MapLibre."
},
"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."
},
"volatile": {
"type": "boolean",
"default": false,
"doc": "A setting to determine whether a source's tiles are cached locally.",
"sdk-support": {
"basic functionality": {
"android": "9.3.0",
"ios": "5.10.0",
"js": "wontfix"
}
}
},
"*": {
"type": "*",
"doc": "Other keys to configure the data source."
}
},
"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:` and `https:`."
},
"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 MapLibre."
},
"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."
},
"custom": {
"doc": "Decodes tiles using the redFactor, blueFactor, greenFactor, baseShift parameters."
}
},
"default": "mapbox",
"doc": "The encoding used by this source. Mapbox Terrain RGB is used by default.",
"sdk-support": {
"mapbox, terrarium": {
"js": "0.43.0",
"ios": "6.0.0",
"android": "6.0.0"
},
"custom": {
"js": "3.4.0",
"ios": "https://github.com/maplibre/maplibre-native/issues/2783",
"android": "https://github.com/maplibre/maplibre-native/issues/2783"
}
}
},
"redFactor": {
"type": "number",
"default": 1.0,
"doc": "Value that will be multiplied by the red channel value when decoding. Only used on custom encodings.",
"sdk-support": {
"basic functionality": {
"js": "3.4.0",
"ios": "https://github.com/maplibre/maplibre-native/issues/2783",
"android": "https://github.com/maplibre/maplibre-native/issues/2783"
}
}
},
"blueFactor": {
"type": "number",
"default": 1.0,
"doc": "Value that will be multiplied by the blue channel value when decoding. Only used on custom encodings.",
"sdk-support": {
"basic functionality": {
"js": "3.4.0",
"ios": "https://github.com/maplibre/maplibre-native/issues/2783",
"android": "https://github.com/maplibre/maplibre-native/issues/2783"
}
}
},
"greenFactor": {
"type": "number",
"default": 1.0,
"doc": "Value that will be multiplied by the green channel value when decoding. Only used on custom encodings.",
"sdk-support": {
"basic functionality": {
"js": "3.4.0",
"ios": "https://github.com/maplibre/maplibre-native/issues/2358",
"android": "https://github.com/maplibre/maplibre-native/issues/2783"
}
}
},
"baseShift": {
"type": "number",
"default": 0.0,
"doc": "Value that will be added to the encoding mix when decoding. Only used on custom encodings.",
"sdk-support": {
"basic functionality": {
"js": "3.4.0",
"ios": "https://github.com/maplibre/maplibre-native/issues/2783",
"android": "https://github.com/maplibre/maplibre-native/issues/2783"
}
}
},
"volatile": {
"type": "boolean",
"default": false,
"doc": "A setting to determine whether a source's tiles are cached locally.",
"sdk-support": {
"basic functionality": {
"android": "9.3.0",
"ios": "5.10.0",
"js": "wontfix"
}
}
},
"*": {
"type": "*",
"doc": "Other keys to configure the data source."
}
},
"source_geojson": {
"type": {
"required": true,
"type": "enum",
"values": {
"geojson": {
"doc": "A GeoJSON data source."
}
},
"doc": "The data type of the GeoJSON source."
},
"data": {
"required": true,
"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."
},
"filter": {
"type": "*",
"doc": "An expression for filtering features prior to processing them for rendering."
},
"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\n * `cluster` Is `true` if the point is a cluster \n\n * `cluster_id` A unique id for the cluster to be used in conjunction with the [cluster inspection methods](https://maplibre.org/maplibre-gl-js/docs/API/classes/GeoJSONSource/#getclusterexpansionzoom)\n\n * `point_count` Number of original points grouped into this cluster\n\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). Clusters are re-evaluated at integer zoom levels so setting clusterMaxZoom to 14 means the clusters will be displayed until z15."
},
"clusterMinPoints": {
"type": "number",
"doc": "Minimum number of points necessary to form a cluster if clustering is enabled. Defaults to `2`."
},
"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\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."
},
"promoteId": {
"type": "promoteId",
"doc": "A property to use as a feature id (for feature state). Either a property name, or an object of the form `{: }`."
}
},
"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."
}
}
},
"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."
}
}
},
"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"
}
}
},
"line": {
"doc": "A stroked line.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.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"
}
}
},
"circle": {
"doc": "A filled circle.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
}
},
"heatmap": {
"doc": "A heatmap.",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"fill-extrusion": {
"doc": "An extruded (3D) polygon.",
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.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"
}
}
},
"hillshade": {
"doc": "Client-side hillshading visualization based on DEM data. The implementation supports Mapbox Terrain RGB, Mapzen Terrarium tiles and custom encodings.",
"sdk-support": {
"basic functionality": {
"js": "0.43.0",
"android": "6.0.0",
"ios": "4.0.0"
},
"additional methods": {
"js": "5.5.0",
"android": "https://github.com/maplibre/maplibre-native/issues/3396",
"ios": "https://github.com/maplibre/maplibre-native/issues/3396"
}
}
},
"color-relief": {
"doc": "Client-side elevation coloring based on DEM data. The implementation supports Mapbox Terrain RGB, Mapzen Terrarium tiles and custom encodings.",
"sdk-support": {
"basic functionality": {
"js": "5.6.0",
"android": "https://github.com/maplibre/maplibre-native/issues/3408",
"ios": "https://github.com/maplibre/maplibre-native/issues/3408"
}
}
},
"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"
}
}
}
},
"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 'maplibre:'.",
"example": {
"source:comment": "Hydrology FCCODE 460 - Narrow wash"
}
},
"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."
}
},
"layout": [
"layout_fill",
"layout_line",
"layout_circle",
"layout_heatmap",
"layout_fill-extrusion",
"layout_symbol",
"layout_raster",
"layout_hillshade",
"layout_color-relief",
"layout_background"
],
"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"
}
},
"property-type": "constant"
}
},
"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": {
"basic functionality": {
"js": "1.2.0",
"android": "9.1.0",
"ios": "5.8.0"
},
"data-driven styling": {
"js": "1.2.0",
"android": "9.1.0",
"ios": "5.8.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"
}
},
"property-type": "constant"
}
},
"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": {
"basic functionality": {
"js": "1.2.0",
"android": "9.2.0",
"ios": "5.9.0"
},
"data-driven styling": {
"js": "1.2.0",
"android": "9.2.0",
"ios": "5.9.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"
}
},
"property-type": "constant"
}
},
"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"
}
},
"property-type": "constant"
}
},
"layout_fill-extrusion": {
"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.27.0",
"android": "5.1.0",
"ios": "3.6.0"
}
},
"property-type": "constant"
}
},
"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"
}
},
"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"
},
"data-driven styling": {
"js": "0.40.0",
"android": "5.2.0",
"ios": "3.7.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"
}
},
"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"
}
},
"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": {
"basic functionality": {
"js": "1.2.0",
"android": "9.1.0",
"ios": "5.8.0"
},
"data-driven styling": {
"js": "1.2.0",
"android": "9.1.0",
"ios": "5.8.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"
}
},
"property-type": "constant"
}
},
"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"
},
"`line-center` value": {
"js": "0.47.0",
"android": "6.4.0",
"ios": "4.3.0"
}
},
"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"
}
},
"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. When using a client that supports global collision detection, like MapLibre GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"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 lower sort keys are drawn and placed first. When `icon-allow-overlap` or `text-allow-overlap` is `false`, features with a lower sort key will have priority during placement. When `icon-allow-overlap` or `text-allow-overlap` is set to `true`, features with a higher sort key will overlap over features with a lower sort key.",
"sdk-support": {
"basic functionality": {
"js": "0.53.0",
"android": "7.4.0",
"ios": "4.11.0"
},
"data-driven styling": {
"js": "0.53.0",
"android": "7.4.0",
"ios": "4.11.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"symbol-z-order": {
"type": "enum",
"values": {
"auto": {
"doc": "Sorts symbols by `symbol-sort-key` if set. Otherwise, sorts symbols by their y-position relative to the viewport if `icon-allow-overlap` or `text-allow-overlap` is set to `true` or `icon-ignore-placement` or `text-ignore-placement` is `false`."
},
"viewport-y": {
"doc": "Sorts symbols by their y-position relative to the viewport if `icon-allow-overlap` or `text-allow-overlap` is set to `true` or `icon-ignore-placement` or `text-ignore-placement` is `false`."
},
"source": {
"doc": "Sorts symbols by `symbol-sort-key` if set. Otherwise, no sorting is applied; symbols are rendered in the same order as the source data."
}
},
"default": "auto",
"doc": "Determines whether overlapping symbols in the same layer are rendered in the order that they appear in the data source or by their y-position relative to the viewport. To control the order and prioritization of symbols otherwise, use `symbol-sort-key`.",
"sdk-support": {
"basic functionality": {
"js": "0.49.0",
"android": "6.6.0",
"ios": "4.5.0"
}
},
"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",
{
"!": "icon-overlap"
}
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"icon-overlap": {
"type": "enum",
"values": {
"never": {
"doc": "The icon will be hidden if it collides with any other previously drawn symbol."
},
"always": {
"doc": "The icon will be visible even if it collides with any other previously drawn symbol."
},
"cooperative": {
"doc": "If the icon collides with another previously drawn symbol, the overlap mode for that symbol is checked. If the previous symbol was placed using `never` overlap mode, the new icon is hidden. If the previous symbol was placed using `always` or `cooperative` overlap mode, the new icon is visible."
}
},
"doc": "Allows for control over whether to show an icon when it overlaps other symbols on the map. If `icon-overlap` is not set, `icon-allow-overlap` is used instead.",
"requires": [
"icon-image"
],
"sdk-support": {
"basic functionality": {
"js": "2.1.0",
"android": "https://github.com/maplibre/maplibre-native/issues/251",
"ios": "https://github.com/maplibre/maplibre-native/issues/251"
}
},
"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"
}
},
"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"
}
},
"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"
},
"`auto` value": {
"js": "0.25.0",
"android": "4.2.0",
"ios": "3.4.0"
}
},
"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"
},
"data-driven styling": {
"js": "0.35.0",
"android": "5.1.0",
"ios": "3.6.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"
},
"stretchable icons": {
"js": "1.6.0",
"android": "9.2.0",
"ios": "5.8.0"
}
},
"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"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"icon-image": {
"type": "resolvedImage",
"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"
},
"data-driven styling": {
"js": "0.35.0",
"android": "5.1.0",
"ios": "3.6.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"
},
"data-driven styling": {
"js": "0.21.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"icon-padding": {
"type": "padding",
"default": [2],
"units": "pixels",
"doc": "Size of additional area round 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"
},
"data-driven styling": {
"js": "2.2.0",
"android": "https://github.com/maplibre/maplibre-native/issues/2754",
"ios": "https://github.com/maplibre/maplibre-native/issues/2754"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"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"
}
},
"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"
},
"data-driven styling": {
"js": "0.29.0",
"android": "5.0.0",
"ios": "3.5.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"
},
"data-driven styling": {
"js": "0.40.0",
"android": "5.2.0",
"ios": "3.7.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"
}
},
"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"
},
"`auto` value": {
"js": "0.25.0",
"android": "4.2.0",
"ios": "3.4.0"
}
},
"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`."
},
"viewport-glyph": {
"doc": "When `symbol-placement` is set to `point`, aligns text to the x-axis of the viewport. When `symbol-placement` is set to `line` or `line-center`, aligns glyphs to the x-axis of the viewport and places them along the line."
},
"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"
},
"`auto` value": {
"js": "0.25.0",
"android": "4.2.0",
"ios": "3.4.0"
},
"`viewport-glyph` value": {
"js": "2.1.8",
"android": "https://github.com/maplibre/maplibre-native/issues/250",
"ios": "https://github.com/maplibre/maplibre-native/issues/250"
}
},
"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"
},
"data-driven styling": {
"js": "0.33.0",
"android": "5.0.0",
"ios": "3.5.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": "Fonts to use for displaying text. If the `glyphs` root property is specified, this array is joined together and interpreted as a font stack name. Otherwise, it is interpreted as a cascading fallback list of local font names.",
"requires": [
"text-field"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.43.0",
"android": "6.0.0",
"ios": "4.0.0"
},
"local fonts": {
"js": "https://github.com/maplibre/maplibre-gl-js/issues/3302",
"android": "https://github.com/maplibre/maplibre-native/issues/165",
"ios": "https://github.com/maplibre/maplibre-native/issues/165"
}
},
"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"
},
"data-driven styling": {
"js": "0.35.0",
"android": "5.1.0",
"ios": "3.6.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"
},
"data-driven styling": {
"js": "0.40.0",
"android": "5.2.0",
"ios": "3.7.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"
}
},
"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"
},
"data-driven styling": {
"js": "0.40.0",
"android": "5.2.0",
"ios": "3.7.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"
},
"data-driven styling": {
"js": "0.39.0",
"android": "5.2.0",
"ios": "3.7.0"
},
"auto": {
"js": "0.54.0",
"android": "7.4.0",
"ios": "4.10.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 defaults to using the two-dimensional `text-offset` if present.",
"sdk-support": {
"basic functionality": {
"js": "0.54.0",
"android": "7.4.0",
"ios": "4.10.0"
},
"data-driven styling": {
"js": "0.54.0",
"android": "7.4.0",
"ios": "4.10.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 renderer 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` or the two-dimensional `text-offset`.",
"sdk-support": {
"basic functionality": {
"js": "0.54.0",
"android": "7.4.0",
"ios": "4.10.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"text-variable-anchor-offset": {
"type": "variableAnchorOffsetCollection",
"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, each paired with an offset value. The renderer will attempt to place the label at each location, in order, before moving on to the next location+offset. Use `text-justify: auto` to choose justification based on anchor position. \n\n The length of the array must be even, and must alternate between enum and point entries. i.e., each anchor location must be accompanied by a point, and that point defines the offset when the corresponding anchor location is used. Positive offset values indicate right and down, while negative values indicate left and up. Anchor locations may repeat, allowing the renderer to try multiple offsets to try and place a label using the same anchor. \n\n When present, this property takes precedence over `text-anchor`, `text-variable-anchor`, `text-offset`, and `text-radial-offset`. \n\n ```json \n\n { \"text-variable-anchor-offset\": [\"top\", [0, 4], \"left\", [3,0], \"bottom\", [1, 1]] } \n\n ``` \n\n When the renderer chooses the `top` anchor, `[0, 4]` will be used for `text-offset`; the text will be shifted down by 4 ems. \n\n When the renderer chooses the `left` anchor, `[3, 0]` will be used for `text-offset`; the text will be shifted right by 3 ems.",
"sdk-support": {
"basic functionality": {
"js": "3.3.0",
"ios": "6.8.0",
"android": "11.6.0"
},
"data-driven styling": {
"js": "3.3.0",
"ios": "https://github.com/maplibre/maplibre-native/issues/2358",
"android": "https://github.com/maplibre/maplibre-native/issues/2358"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"text-anchor": {
"type": "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."
}
},
"default": "center",
"doc": "Part of the text placed closest to the anchor.",
"requires": [
"text-field",
{
"!": "text-variable-anchor"
}
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.39.0",
"android": "5.2.0",
"ios": "3.7.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"text-max-angle": {
"type": "number",
"default": 45,
"units": "degrees",
"doc": "Maximum angle change between adjacent characters.",
"requires": [
"text-field",
{
"symbol-placement": [
"line",
"line-center"
]
}
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"text-writing-mode": {
"type": "array",
"value": "enum",
"values": {
"horizontal": {
"doc": "If a text's language supports horizontal writing mode, symbols with point placement would be laid out horizontally."
},
"vertical": {
"doc": "If a text's language supports vertical writing mode, symbols with point placement would be laid out vertically."
}
},
"doc": "The property allows control over a symbol's orientation. Note that the property values act as a hint, so that a symbol whose language doesn’t support the provided orientation will be laid out in its natural orientation. Example: English point symbol will be rendered horizontally even if array value contains single 'vertical' enum value. The order of elements in an array define priority order for the placement of an orientation variant.",
"requires": [
"text-field",
{
"symbol-placement": [
"point"
]
}
],
"sdk-support": {
"basic functionality": {
"js": "1.3.0",
"android": "8.3.0",
"ios": "5.3.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"text-rotate": {
"type": "number",
"default": 0,
"period": 360,
"units": "degrees",
"doc": "Rotates the text clockwise.",
"requires": [
"text-field"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.35.0",
"android": "5.1.0",
"ios": "3.6.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"text-padding": {
"type": "number",
"default": 2,
"minimum": 0,
"units": "pixels",
"doc": "Size of the additional area around the text bounding box used for detecting symbol collisions.",
"requires": [
"text-field"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"text-keep-upright": {
"type": "boolean",
"default": true,
"doc": "If true, the text may be flipped vertically to prevent it from being rendered upside-down.",
"requires": [
"text-field",
{
"text-rotation-alignment": "map"
},
{
"symbol-placement": [
"line",
"line-center"
]
}
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"text-transform": {
"type": "enum",
"values": {
"none": {
"doc": "The text is not altered."
},
"uppercase": {
"doc": "Forces all letters to be displayed in uppercase."
},
"lowercase": {
"doc": "Forces all letters to be displayed in lowercase."
}
},
"default": "none",
"doc": "Specifies how to capitalize text, similar to the CSS `text-transform` property.",
"requires": [
"text-field"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.33.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"text-offset": {
"type": "array",
"doc": "Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. If used with text-variable-anchor, input values will be taken as absolute values. Offsets along the x- and y-axis will be applied automatically based on the anchor position.",
"value": "number",
"units": "ems",
"length": 2,
"default": [
0,
0
],
"requires": [
"text-field",
{
"!": "text-radial-offset"
}
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.35.0",
"android": "5.1.0",
"ios": "3.6.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature"
]
},
"property-type": "data-driven"
},
"text-allow-overlap": {
"type": "boolean",
"default": false,
"doc": "If true, the text will be visible even if it collides with other previously drawn symbols.",
"requires": [
"text-field",
{
"!": "text-overlap"
}
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"text-overlap": {
"type": "enum",
"values": {
"never": {
"doc": "The text will be hidden if it collides with any other previously drawn symbol."
},
"always": {
"doc": "The text will be visible even if it collides with any other previously drawn symbol."
},
"cooperative": {
"doc": "If the text collides with another previously drawn symbol, the overlap mode for that symbol is checked. If the previous symbol was placed using `never` overlap mode, the new text is hidden. If the previous symbol was placed using `always` or `cooperative` overlap mode, the new text is visible."
}
},
"doc": "Allows for control over whether to show symbol text when it overlaps other symbols on the map. If `text-overlap` is not set, `text-allow-overlap` is used instead",
"requires": [
"text-field"
],
"sdk-support": {
"basic functionality": {
"js": "2.1.0",
"android": "https://github.com/maplibre/maplibre-native/issues/251",
"ios": "https://github.com/maplibre/maplibre-native/issues/251"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"text-ignore-placement": {
"type": "boolean",
"default": false,
"doc": "If true, other symbols can be visible even if they collide with the text.",
"requires": [
"text-field"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"text-optional": {
"type": "boolean",
"default": false,
"doc": "If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.",
"requires": [
"text-field",
"icon-image"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"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"
}
},
"property-type": "constant"
}
},
"layout_raster": {
"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"
}
},
"property-type": "constant"
}
},
"layout_hillshade": {
"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.43.0",
"android": "6.0.0",
"ios": "4.0.0"
}
},
"property-type": "constant"
}
},
"layout_color-relief": {
"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": {
}
},
"property-type": "constant"
}
},
"filter": {
"type": "array",
"value": "*",
"doc": "A filter selects specific features from a layer."
},
"filter_operator": {
"type": "enum",
"values": {
"==": {
"doc": "`[\"==\", key, value]` equality: `feature[key] = value`"
},
"!=": {
"doc": "`[\"!=\", key, value]` inequality: `feature[key] ≠ value`"
},
">": {
"doc": "`[\">\", key, value]` greater than: `feature[key] > value`"
},
">=": {
"doc": "`[\">=\", key, value]` greater than or equal: `feature[key] ≥ value`"
},
"<": {
"doc": "`[\"<\", key, value]` less than: `feature[key] < value`"
},
"<=": {
"doc": "`[\"<=\", key, value]` less than or equal: `feature[key] ≤ value`"
},
"in": {
"doc": "`[\"in\", key, v0, ..., vn]` set inclusion: `feature[key] ∈ {v0, ..., vn}`"
},
"!in": {
"doc": "`[\"!in\", key, v0, ..., vn]` set exclusion: `feature[key] ∉ {v0, ..., vn}`"
},
"all": {
"doc": "`[\"all\", f0, ..., fn]` logical `AND`: `f0 ∧ ... ∧ fn`"
},
"any": {
"doc": "`[\"any\", f0, ..., fn]` logical `OR`: `f0 ∨ ... ∨ fn`"
},
"none": {
"doc": "`[\"none\", f0, ..., fn]` logical `NOR`: `¬f0 ∧ ... ∧ ¬fn`"
},
"has": {
"doc": "`[\"has\", key]` `feature[key]` exists"
},
"!has": {
"doc": "`[\"!has\", key]` `feature[key]` does not exist"
}
},
"doc": "The filter operator."
},
"geometry_type": {
"type": "enum",
"values": {
"Point": {
"doc": "Filter to point geometries."
},
"LineString": {
"doc": "Filter to line geometries."
},
"Polygon": {
"doc": "Filter to polygon geometries."
}
},
"doc": "The geometry type for the filter to select."
},
"function": {
"expression": {
"type": "expression",
"doc": "An expression."
},
"stops": {
"type": "array",
"doc": "An array of stops.",
"value": "function_stop"
},
"base": {
"type": "number",
"default": 1,
"minimum": 0,
"doc": "The exponential base of the interpolation curve. It controls the rate at which the result increases. Higher values make the result increase more towards the high end of the range. With `1` the stops are interpolated linearly."
},
"property": {
"type": "string",
"doc": "The name of a feature property to use as the function input.",
"default": "$zoom"
},
"type": {
"type": "enum",
"values": {
"identity": {
"doc": "Return the input value as the output value."
},
"exponential": {
"doc": "Generate an output by interpolating between stops just less than and just greater than the function input."
},
"interval": {
"doc": "Return the output value of the stop just less than the function input."
},
"categorical": {
"doc": "Return the output value of the stop equal to the function input."
}
},
"doc": "The interpolation strategy to use in function evaluation.",
"default": "exponential"
},
"colorSpace": {
"type": "enum",
"values": {
"rgb": {
"doc": "Use the RGB color space to interpolate color values"
},
"lab": {
"doc": "Use the LAB color space to interpolate color values."
},
"hcl": {
"doc": "Use the HCL color space to interpolate color values, interpolating the Hue, Chroma, and Luminance channels individually."
}
},
"doc": "The color space in which colors interpolated. Interpolating colors in perceptual color spaces like LAB and HCL tend to produce color ramps that look more consistent and produce colors that can be differentiated more easily than those interpolated in RGB space.",
"default": "rgb"
},
"default": {
"type": "*",
"required": false,
"doc": "A value to serve as a fallback function result when a value isn't otherwise available. It is used in the following circumstances:\n\n* In categorical functions, when the feature value does not match any of the stop domain values.\n\n* In property and zoom-and-property functions, when a feature does not contain a value for the specified property.\n\n* In identity functions, when the feature value is not valid for the style property (for example, if the function is being used for a `circle-color` property but the feature property value is not a string or not a valid color).\n\n* In interval or exponential property and zoom-and-property functions, when the feature value is not numeric.\n\nIf no default is provided, the style property's default is used in these circumstances."
}
},
"function_stop": {
"type": "array",
"minimum": 0,
"maximum": 24,
"value": [
"number",
"color"
],
"length": 2,
"doc": "Zoom level and value pair."
},
"expression": {
"type": "array",
"value": "*",
"minimum": 1,
"doc": "An expression defines a function that can be used for data-driven style properties or feature filters."
},
"expression_name": {
"doc": "",
"type": "enum",
"values": {
"let": {
"doc": "Binds expressions to named variables, which can then be referenced in the result expression using `[\"var\", \"variable_name\"]`.\n\n - [Visualize population density](https://maplibre.org/maplibre-gl-js/docs/examples/visualize-population-density/)",
"syntax": {
"overloads": [
{
"parameters": ["var_1_name", "var_1_value", "...", "var_n_name", "var_n_value", "expression"],
"output-type": "any"
}
],
"parameters": [
{
"name": "var_i_name",
"type": "string literal",
"description": "The name of the i-th variable."
},
{
"name": "var_i_value",
"type": "any",
"description": "The value of the i-th variable."
},
{
"name": "expression",
"type": "any",
"description": "The expression within which the named variables can be referenced."
}
]
},
"example": ["let", "someNumber", 500, ["interpolate", ["linear"], ["var", "someNumber"], 274, "#edf8e9", 1551, "#006d2c"]],
"group": "Variable binding",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"var": {
"doc": "References variable bound using `let`.\n\n - [Visualize population density](https://maplibre.org/maplibre-gl-js/docs/examples/visualize-population-density/)",
"syntax": {
"overloads": [
{
"parameters": ["var_name"],
"output-type": "any"
}
],
"parameters": [
{
"name": "var_name",
"type": "string literal",
"description": "The name of the variable bound using `let`."
}
]
},
"example": ["var", "density"],
"group": "Variable binding",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"literal": {
"doc": "Provides a literal array or object value.\n\n - [Display and style rich text labels](https://maplibre.org/maplibre-gl-js/docs/examples/display-and-style-rich-text-labels/)",
"syntax": {
"overloads": [
{
"parameters": ["json_object"],
"output-type": "object"
},
{
"parameters": ["json_array"],
"output-type": "array"
}
],
"parameters": [
{
"name": "json_object",
"type": "JSON object"
},
{
"name": "json_array",
"type": "JSON array"
}
]
},
"example": ["literal", ["DIN Offc Pro Italic", "Arial Unicode MS Regular"]],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"array": {
"doc": "Asserts that the input is an array (optionally with a specific item type and length). If, when the input expression is evaluated, it is not of the asserted type or length, then this assertion will cause the whole expression to be aborted.",
"syntax": {
"overloads": [
{
"parameters": ["value"],
"output-type": "array"
},
{
"parameters": ["type", "value"],
"output-type": "array"
},
{
"parameters": ["type", "length", "value"],
"output-type": "array"
}
],
"parameters": [
{
"name": "value",
"type": "any"
},
{
"name": "type",
"type": "\"string\" | \"number\" | \"boolean\"",
"description": "The asserted type of the input array."
},
{
"name": "length",
"type": "number literal",
"description": "The asserted length of the input array."
}
]
},
"example": ["array", "string", 3, ["literal", ["a", "b", "c"]]],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"at": {
"doc": "Retrieves an item from an array.",
"syntax": {
"overloads": [
{
"parameters": ["index", "array"],
"output-type": "T"
}
],
"parameters": [
{
"name": "index",
"type": "number",
"description": "The index into `array`."
},
{
"name": "array",
"type": "array",
"description": "The array of items to retrieve the specified item from."
}
]
},
"example": ["at", 1, ["literal", ["a", "b", "c"]]],
"group": "Lookup",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"in": {
"doc": "Determines whether an item exists in an array or a substring exists in a string.\n\n - [Measure distances](https://maplibre.org/maplibre-gl-js/docs/examples/measure-distances/)",
"syntax": {
"overloads": [
{
"parameters": ["item", "array"],
"output-type": "boolean"
},
{
"parameters": ["substring", "string"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "item",
"type": "T",
"description": "The needle to search for within `array`."
},
{
"name": "array",
"type": "array",
"description": "The haystack through which to search for `item`."
},
{
"name": "substring",
"type": "string",
"description": "The needle to search for within `string`."
},
{
"name": "string",
"type": "string",
"description": "The haystack through which to search for `substring`."
}
]
},
"example": ["in", "$type", "Point"],
"group": "Lookup",
"sdk-support": {
"basic functionality": {
"js": "1.6.0",
"android": "9.1.0",
"ios": "5.8.0"
}
}
},
"index-of": {
"doc": "Returns the first position at which an item can be found in an array or a substring can be found in a string, or `-1` if the input cannot be found. Accepts an optional index from where to begin the search. In a string, a UTF-16 surrogate pair counts as a single position.",
"syntax": {
"overloads": [
{
"parameters": ["item", "array", "from_index?"],
"output-type": "number"
},
{
"parameters": ["substring", "string", "from_index?"],
"output-type": "number"
}
],
"parameters": [
{
"name": "item",
"type": "T",
"description": "The needle to search for within `array`."
},
{
"name": "array",
"type": "array",
"description": "The haystack through which to search for `item`."
},
{
"name": "substring",
"type": "string",
"description": "The needle to search for within `string`."
},
{
"name": "string",
"type": "string",
"description": "The haystack through which to search for `substring`."
},
{
"name": "from_index",
"type": "number",
"description": "The index from where to begin the search."
}
]
},
"example": ["index-of", "foo", ["baz", "bar", "hello", "foo", "world"]],
"group": "Lookup",
"sdk-support": {
"basic functionality": {
"js": "1.10.0",
"android": "10.3.0",
"ios": "6.0.0"
}
}
},
"slice": {
"doc": "Returns a subarray from an array or a substring from a string from a specified start index, or between a start index and an end index if set. The return value is inclusive of the start index but not of the end index. In a string, a UTF-16 surrogate pair counts as a single position.",
"syntax": {
"overloads": [
{
"parameters": ["array", "start_index", "end_index?"],
"output-type": "array"
},
{
"parameters": ["string", "start_index", "end_index?"],
"output-type": "string"
}
],
"parameters": [
{
"name": "array",
"type": "array",
"description": "The original array from which to extract the subarray."
},
{
"name": "string",
"type": "string",
"description": "The original string from which to extract the substring."
},
{
"name": "start_index",
"type": "number",
"description": "The inclusive index from which `slice` extracts items or characters from the subarray or substring."
},
{
"name": "end_index",
"type": "number",
"description": "The non-inclusive index up to which `slice` extracts items or characters from the subarray or substring."
}
]
},
"example": ["slice", ["get", "name"], 0, 3],
"group": "Lookup",
"sdk-support": {
"basic functionality": {
"js": "1.10.0",
"android": "10.3.0",
"ios": "6.0.0"
}
}
},
"case": {
"doc": "Selects the first output whose corresponding test condition evaluates to true, or the fallback value otherwise.\n\n - [Create a hover effect](https://maplibre.org/maplibre-gl-js/docs/examples/create-a-hover-effect/)\n\n - [Display HTML clusters with custom properties](https://maplibre.org/maplibre-gl-js/docs/examples/display-html-clusters-with-custom-properties/)",
"syntax": {
"overloads": [
{
"parameters": ["condition_1", "output_1", "...", "condition_n", "output_n", "fallback"],
"output-type": "any"
}
],
"parameters": [
{
"name": "condition_i",
"type": "boolean"
},
{
"name": "output_i",
"type": "any"
},
{
"name": "fallback",
"type": "any",
"description": "The result when no condition evaluates to true."
}
]
},
"example": ["case", ["boolean", ["feature-state", "hover"], false], 1, 0.5],
"group": "Decision",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"match": {
"doc": "Selects the output whose label value matches the input value, or the fallback value if no match is found. The input can be any expression (e.g. `[\"get\", \"building_type\"]`). Each label must be either:\n\n - a single literal value; or\n\n - an array of literal values, whose values must be all strings or all numbers (e.g. `[100, 101]` or `[\"c\", \"b\"]`). The input matches if any of the values in the array matches, similar to the `\"in\"` operator.\n\nEach label must be unique. If the input type does not match the type of the labels, the result will be the fallback value.",
"syntax": {
"overloads": [
{
"parameters": ["input", "label_1", "output_1", "...", "label_n", "output_n", "fallback"],
"output-type": "any"
}
],
"parameters": [
{
"name": "input",
"type": "string | number",
"description": "Any expression."
},
{
"name": "label_i",
"type": "string literal | number literal | array | array",
"description": "The i-th literal value or array of literal values to match the input against."
},
{
"name": "output_i",
"type": "any",
"description": "The result when the i-th label is the first label to match the input."
},
{
"name": "fallback",
"type": "any",
"description": "The result when no label matches the input."
}
]
},
"example": ["match", ["get", "building_type"], "residential", "#f00", "commercial", "#0f0", "#000"],
"group": "Decision",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"coalesce": {
"doc": "Evaluates each expression in turn until the first non-null value is obtained, and returns that value.\n\n - [Use a fallback image](https://maplibre.org/maplibre-gl-js/docs/examples/use-a-fallback-image/)",
"syntax": {
"overloads": [
{
"parameters": ["expression_1", "...", "expression_n"],
"output-type": "any"
}
],
"parameters": [
{
"name": "expression_i",
"type": "any"
}
]
},
"example": ["coalesce", ["image", ["concat", ["get", "icon"], "_15"]], ["image", "marker_15"]],
"group": "Decision",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"step": {
"doc": "Produces discrete, stepped results by evaluating a piecewise-constant function defined by pairs of input and output values (\"stops\"). The `input` may be any numeric expression (e.g., `[\"get\", \"population\"]`). Stop inputs must be numeric literals in strictly ascending order.\n\nReturns the output value of the stop just less than the input, or the first output if the input is less than the first stop.\n\n - [Create and style clusters](https://maplibre.org/maplibre-gl-js/docs/examples/create-and-style-clusters/)",
"syntax": {
"overloads": [
{
"parameters": ["input", "output_0", "stop_1_input", "stop_1_output", "...", "stop_n_input", "stop_n_output"],
"output-type": "any"
}
],
"parameters": [
{
"name": "input",
"type": "number",
"description": "Any numeric expression."
},
{
"name": "output_0",
"type": "any",
"description": "The result when the `input` is less than the first stop."
},
{
"name": "stop_i_input",
"type": "number literal",
"description": "The value of the i-th stop against which the `input` is compared."
},
{
"name": "stop_i_output",
"type": "any",
"description": "The result when the i-th stop is the last stop less than the `input`."
}
]
},
"example": ["step", ["get", "point_count"], 20, 100, 30, 750, 40],
"group": "Ramps, scales, curves",
"sdk-support": {
"basic functionality": {
"js": "0.42.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"interpolate": {
"doc": "Produces continuous, smooth results by interpolating between pairs of input and output values (\"stops\"). The `input` may be any numeric expression (e.g., `[\"get\", \"population\"]`). Stop inputs must be numeric literals in strictly ascending order. The output type must be `number`, `array`, `color`, `array`, or `projection`.\n\nInterpolation types:\n\n- `[\"linear\"]`, or an expression returning one of those types: Interpolates linearly between the pair of stops just less than and just greater than the input.\n\n- `[\"exponential\", base]`: Interpolates exponentially between the stops just less than and just greater than the input. `base` controls the rate at which the output increases: higher values make the output increase more towards the high end of the range. With values close to 1 the output increases linearly.\n\n- `[\"cubic-bezier\", x1, y1, x2, y2]`: Interpolates using the cubic bezier curve defined by the given control points.\n\n - [Animate map camera around a point](https://maplibre.org/maplibre-gl-js/docs/examples/animate-camera-around-point/)\n\n - [Change building color based on zoom level](https://maplibre.org/maplibre-gl-js/docs/examples/change-building-color-based-on-zoom-level/)\n\n - [Create a heatmap layer](https://maplibre.org/maplibre-gl-js/docs/examples/heatmap-layer/)\n\n - [Visualize population density](https://maplibre.org/maplibre-gl-js/docs/examples/visualize-population-density/)",
"syntax": {
"overloads": [
{
"parameters": ["interpolation_type", "input", "stop_1_input", "stop_1_output", "...", "stop_n_input", "stop_n_output"],
"output-type": "number | array | color | array | projection"
}
],
"parameters": [
{
"name": "interpolation_type",
"type": "[\"linear\"] | [\"exponential\", base] | [\"cubic-bezier\", x1, y1, x2, y2]",
"description": "The interpolation type."
},
{
"name": "input",
"type": "number",
"description": "Any numeric expression."
},
{
"name": "stop_i_input",
"type": "number literal",
"description": "The value of the i-th stop against which the `input` is compared."
},
{
"name": "stop_i_output",
"type": "number | array | color | array | projection",
"description": "The output value corresponding to the i-th stop."
}
]
},
"example": ["interpolate", ["linear"], ["zoom"], 15, 0, 15.05, ["get", "height"]],
"group": "Ramps, scales, curves",
"sdk-support": {
"basic functionality": {
"js": "0.42.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"interpolate-hcl": {
"doc": "Produces continuous, smooth results by interpolating between pairs of input and output values (\"stops\"). Works like `interpolate`, but the output type must be `color` or `array`, and the interpolation is performed in the Hue-Chroma-Luminance color space.",
"syntax": {
"overloads": [
{
"parameters": ["interpolation_type", "input", "stop_1_input", "stop_1_output", "...", "stop_n_input", "stop_n_output"],
"output-type": "color | array"
}
],
"parameters": [
{
"name": "interpolation_type",
"type": "[\"linear\"] | [\"exponential\", base] | [\"cubic-bezier\", x1, y1, x2, y2]"
},
{
"name": "input",
"type": "number"
},
{
"name": "stop_i_input",
"type": "number literal"
},
{
"name": "stop_i_output",
"type": "color | array"
}
]
},
"example": ["interpolate-hcl", ["linear"], ["zoom"], 15, "#f00", 15.05, "#00f"],
"group": "Ramps, scales, curves",
"sdk-support": {
"basic functionality": {
"js": "0.49.0",
"ios": "https://github.com/maplibre/maplibre-native/issues/2784",
"android": "https://github.com/maplibre/maplibre-native/issues/2784"
}
}
},
"interpolate-lab": {
"doc": "Produces continuous, smooth results by interpolating between pairs of input and output values (\"stops\"). Works like `interpolate`, but the output type must be `color` or `array`, and the interpolation is performed in the CIELAB color space.",
"syntax": {
"overloads": [
{
"parameters": ["interpolation_type", "input", "stop_1_input", "stop_1_output", "...", "stop_n_input", "stop_n_output"],
"output-type": "color | array"
}
],
"parameters": [
{
"name": "interpolation_type",
"type": "[\"linear\"] | [\"exponential\", base] | [\"cubic-bezier\", x1, y1, x2, y2]"
},
{
"name": "input",
"type": "number"
},
{
"name": "stop_i_input",
"type": "number literal"
},
{
"name": "stop_i_output",
"type": "color | array"
}
]
},
"example": ["interpolate-lab", ["linear"], ["zoom"], 15, "#f00", 15.05, "#00f"],
"group": "Ramps, scales, curves",
"sdk-support": {
"basic functionality": {
"js": "0.49.0",
"ios": "https://github.com/maplibre/maplibre-native/issues/2784",
"android": "https://github.com/maplibre/maplibre-native/issues/2784"
}
}
},
"ln2": {
"doc": "Returns the mathematical constant ln(2).",
"syntax": {
"overloads": [
{
"parameters": [],
"output-type": "number"
}
]
},
"example": ["ln2"],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"pi": {
"doc": "Returns the mathematical constant pi.",
"syntax": {
"overloads": [
{
"parameters": [],
"output-type": "number"
}
]
},
"example": ["pi"],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"e": {
"doc": "Returns the mathematical constant e.",
"syntax": {
"overloads": [
{
"parameters": [],
"output-type": "number"
}
]
},
"example": ["e"],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"typeof": {
"doc": "Returns a string describing the type of the given value.",
"syntax": {
"overloads": [
{
"parameters": ["value"],
"output-type": "string"
}
],
"parameters": [
{
"name": "value",
"type": "any"
}
]
},
"example": ["typeof", ["get", "name"]],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"string": {
"doc": "Asserts that the input value is a string. If multiple values are provided, each one is evaluated in order until a string is obtained. If none of the inputs are strings, the expression is an error.",
"syntax": {
"overloads": [
{
"parameters": ["value_1", "...", "value_n"],
"output-type": "string"
}
],
"parameters": [
{
"name": "value_i",
"type": "any"
}
]
},
"example": ["string", ["get", "name"]],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"number": {
"doc": "Asserts that the input value is a number. If multiple values are provided, each one is evaluated in order until a number is obtained. If none of the inputs are numbers, the expression is an error.",
"syntax": {
"overloads": [
{
"parameters": ["value_1", "...", "value_n"],
"output-type": "number"
}
],
"parameters": [
{
"name": "value_i",
"type": "any"
}
]
},
"example": ["number", ["get", "population"]],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"boolean": {
"doc": "Asserts that the input value is a boolean. If multiple values are provided, each one is evaluated in order until a boolean is obtained. If none of the inputs are booleans, the expression is an error.\n\n - [Create a hover effect](https://maplibre.org/maplibre-gl-js/docs/examples/create-a-hover-effect/)",
"syntax": {
"overloads": [
{
"parameters": ["value_1", "...", "value_n"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "value_i",
"type": "any"
}
]
},
"example": ["boolean", ["feature-state", "hover"], false],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"object": {
"doc": "Asserts that the input value is an object. If multiple values are provided, each one is evaluated in order until an object is obtained. If none of the inputs are objects, the expression is an error.",
"syntax": {
"overloads": [
{
"parameters": ["value_1", "...", "value_n"],
"output-type": "object"
}
],
"parameters": [
{
"name": "value_i",
"type": "any"
}
]
},
"example": ["object", ["get", "some-property"]],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"collator": {
"doc": "Returns a `collator` for use in locale-dependent comparison operations. The `case-sensitive` and `diacritic-sensitive` options default to `false`. The `locale` argument specifies the IETF language tag of the locale to use. If none is provided, the default locale is used. If the requested locale is not available, the `collator` will use a system-defined fallback locale. Use `resolved-locale` to test the results of locale fallback behavior.",
"syntax": {
"overloads": [
{
"parameters": ["options"],
"output-type": "collator"
}
],
"parameters": [
{
"name": "options",
"type": "{ \"case-sensitive\"?: boolean, \"diacritic-sensitive\"?: boolean, \"locale\"?: string }"
}
]
},
"example": ["collator", {"case-sensitive": true, "diacritic-sensitive": true, "locale": "fr"}],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "0.45.0",
"android": "6.5.0",
"ios": "4.2.0"
}
}
},
"format": {
"doc": "Returns a `formatted` string for displaying mixed-format text in the `text-field` property. The input may contain a string literal or expression, including an [`'image'`](#image) expression. Strings may be followed by a style override object that supports the following properties:\n\n- `\"text-font\"`: Overrides the font stack specified by the root layout property.\n\n- `\"text-color\"`: Overrides the color specified by the root paint property.\n\n- `\"font-scale\"`: Applies a scaling factor on `text-size` as specified by the root layout property.\n\n- `\"vertical-align\"`: Aligns vertically text section or image in relation to the row it belongs to. Possible values are: \n\t- `\"bottom\"` *default*: align the bottom of this section with the bottom of other sections.\n![\"Visual](\"https://github.com/user-attachments/assets/0474a2fd-a4b2-417c-9187-7a13a28695bc\"/)
\n\t- `\"center\"`: align the center of this section with the center of other sections.\n![\"Visual](\"https://github.com/user-attachments/assets/92237455-be6d-4c5d-b8f6-8127effc1950\"/)
\n\t- `\"top\"`: align the top of this section with the top of other sections.\n![\"Visual](\"https://github.com/user-attachments/assets/45dccb28-d977-4abb-a006-4ea9792b7c53\"/)
\n\t- Refer to [the design proposal](https://github.com/maplibre/maplibre-style-spec/issues/832) for more details.\n\n - [Change the case of labels](https://maplibre.org/maplibre-gl-js/docs/examples/change-case-of-labels/)\n\n - [Display and style rich text labels](https://maplibre.org/maplibre-gl-js/docs/examples/display-and-style-rich-text-labels/)",
"syntax": {
"overloads": [
{
"parameters": ["input_1", "style_overrides_1?", "...", "input_n", "style_overrides_n?"],
"output-type": "formatted"
}
],
"parameters": [
{
"name": "input_i",
"type": "string | image"
},
{
"name": "style_overrides_i",
"type": "{ \"text-font\"?: string, \"text-color\"?: color, \"font-scale\"?: number, \"vertical-align\"?: \"bottom\" | \"center\" | \"top\" }"
}
]
},
"example": ["format", ["upcase", ["get", "FacilityName"]], {"font-scale": 0.8}, "\n\n", {}, ["downcase", ["get", "Comments"]], {"font-scale": 0.6, "vertical-align": "center"}],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "0.48.0",
"android": "6.7.0",
"ios": "4.6.0"
},
"text-font": {
"js": "0.48.0",
"android": "6.7.0",
"ios": "4.6.0"
},
"font-scale": {
"js": "0.48.0",
"android": "6.7.0",
"ios": "4.6.0"
},
"text-color": {
"js": "1.3.0",
"android": "7.3.0",
"ios": "4.10.0"
},
"vertical-align": {
"js": "5.1.0",
"android": "https://github.com/maplibre/maplibre-native/issues/3055",
"ios": "https://github.com/maplibre/maplibre-native/issues/3055"
},
"image": {
"js": "1.6.0",
"android": "8.6.0",
"ios": "5.7.0"
}
}
},
"image": {
"doc": "Returns an `image` type for use in `icon-image`, `*-pattern` entries and as a section in the `format` expression. If set, the `image` argument will check that the requested image exists in the style and will return either the resolved image name or `null`, depending on whether or not the image is currently in the style. This validation process is synchronous and requires the image to have been added to the style before requesting it in the `image` argument.\n\n - [Use a fallback image](https://maplibre.org/maplibre-gl-js/docs/examples/use-a-fallback-image/)",
"syntax": {
"overloads": [
{
"parameters": ["image_name"],
"output-type": "image"
}
],
"parameters": [
{
"name": "image_name",
"type": "string"
}
]
},
"example": ["image", "marker_15"],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "1.4.0",
"android": "8.6.0",
"ios": "5.7.0"
}
}
},
"global-state": {
"doc": "Retrieves a property value from global state that can be set with platform-specific APIs. Defaults can be provided using the [`state`](https://maplibre.org/maplibre-style-spec/root/#state) root property. Returns `null` if no value nor default value is set for the retrieved property.",
"group": "Lookup",
"syntax": {
"overloads": [
{
"parameters": ["property_name"],
"output-type": "any"
}
],
"parameters": [
{
"name": "property_name",
"type": "string literal",
"description": "The name of the global state property to retrieve."
}
]
},
"example": ["global-state", "someProperty"],
"sdk-support": {
"basic functionality": {
"js": "https://github.com/maplibre/maplibre-gl-js/issues/4964",
"android": "https://github.com/maplibre/maplibre-native/issues/3302",
"ios": "https://github.com/maplibre/maplibre-native/issues/3302"
}
}
},
"number-format": {
"doc": "Converts the input number into a string representation using the providing formatting rules. If set, the `locale` argument specifies the locale to use, as a BCP 47 language tag. If set, the `currency` argument specifies an ISO 4217 code to use for currency-style formatting. If set, the `min-fraction-digits` and `max-fraction-digits` arguments specify the minimum and maximum number of fractional digits to include.\n\n - [Display HTML clusters with custom properties](https://maplibre.org/maplibre-gl-js/docs/examples/display-html-clusters-with-custom-properties/)",
"syntax": {
"overloads": [
{
"parameters": ["input", "format_options"],
"output-type": "string"
}
],
"parameters": [
{
"name": "input",
"type": "number"
},
{
"name": "format_options",
"type": "{ \"locale\"?: string, \"currency\"?: string, \"min-fraction-digits\"?: number, \"max-fraction-digits\"?: number }"
}
]
},
"example": ["number-format", ["get", "mag"], {"min-fraction-digits": 1, "max-fraction-digits": 1}],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "0.54.0",
"android": "8.4.0",
"ios": "supported"
}
}
},
"to-string": {
"doc": "Converts the input value to a string. If the input is `null`, the result is `\"\"`. If the input is a boolean, the result is `\"true\"` or `\"false\"`. If the input is a number, it is converted to a string as specified by the [\"NumberToString\" algorithm](https://tc39.github.io/ecma262/#sec-tostring-applied-to-the-number-type) of the ECMAScript Language Specification. If the input is a color, it is converted to a string of the form `\"rgba(r,g,b,a)\"`, where `r`, `g`, and `b` are numerals ranging from 0 to 255, and `a` ranges from 0 to 1. Otherwise, the input is converted to a string in the format specified by the [`JSON.stringify`](https://tc39.github.io/ecma262/#sec-json.stringify) function of the ECMAScript Language Specification.\n\n - [Create a time slider](https://maplibre.org/maplibre-gl-js/docs/examples/create-a-time-slider/)",
"syntax": {
"overloads": [
{
"parameters": ["value"],
"output-type": "string"
}
],
"parameters": [
{
"name": "value",
"type": "any"
}
]
},
"example": ["to-string", ["get", "mag"]],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"to-number": {
"doc": "Converts the input value to a number, if possible. If the input is `null` or `false`, the result is 0. If the input is `true`, the result is 1. If the input is a string, it is converted to a number as specified by the [\"ToNumber Applied to the String Type\" algorithm](https://tc39.github.io/ecma262/#sec-tonumber-applied-to-the-string-type) of the ECMAScript Language Specification. If multiple values are provided, each one is evaluated in order until the first successful conversion is obtained. If none of the inputs can be converted, the expression is an error.",
"syntax": {
"overloads": [
{
"parameters": ["value_1", "...", "value_n"],
"output-type": "number"
}
],
"parameters": [
{
"name": "value_i",
"type": "any"
}
]
},
"example": ["to-number", "someProperty"],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"to-boolean": {
"doc": "Converts the input value to a boolean. The result is `false` when the input is an empty string, 0, `false`, `null`, or `NaN`; otherwise it is `true`.",
"syntax": {
"overloads": [
{
"parameters": ["value"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "value",
"type": "any"
}
]
},
"example": ["to-boolean", "someProperty"],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"to-rgba": {
"doc": "Returns a four-element array containing the input color's red, green, blue, and alpha components, in that order.",
"syntax": {
"overloads": [
{
"parameters": ["color"],
"output-type": "array"
}
],
"parameters": [
{
"name": "color",
"type": "color"
}
]
},
"example": ["to-rgba", "#ff0000"],
"group": "Color",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"to-color": {
"doc": "Converts the input value to a color. If multiple values are provided, each one is evaluated in order until the first successful conversion is obtained. If none of the inputs can be converted, the expression is an error.\n\n - [Visualize population density](https://maplibre.org/maplibre-gl-js/docs/examples/visualize-population-density/)",
"syntax": {
"overloads": [
{
"parameters": ["value_1", "...", "value_n"],
"output-type": "color"
}
],
"parameters": [
{
"name": "value_i",
"type": "any"
}
]
},
"example": ["to-color", "#edf8e9"],
"group": "Types",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"rgb": {
"doc": "Creates a color value from red, green, and blue components, which must range between 0 and 255, and an alpha component of 1. If any component is out of range, the expression is an error.",
"syntax": {
"overloads": [
{
"parameters": ["red", "green", "blue"],
"output-type": "color"
}
],
"parameters": [
{
"name": "red",
"type": "number"
},
{
"name": "green",
"type": "number"
},
{
"name": "blue",
"type": "number"
}
]
},
"example": ["rgb", 255, 0, 0],
"group": "Color",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"rgba": {
"doc": "Creates a color value from red, green, blue components, which must range between 0 and 255, and an alpha component which must range between 0 and 1. If any component is out of range, the expression is an error.",
"syntax": {
"overloads": [
{
"parameters": ["red", "green", "blue", "alpha"],
"output-type": "color"
}
],
"parameters": [
{
"name": "red",
"type": "number"
},
{
"name": "green",
"type": "number"
},
{
"name": "blue",
"type": "number"
},
{
"name": "alpha",
"type": "number"
}
]
},
"example": ["rgba", 255, 0, 0, 1],
"group": "Color",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"get": {
"doc": "Retrieves a property value from the current feature's properties, or from another object if a second argument is provided. Returns null if the requested property is missing.\n\n - [Change the case of labels](https://maplibre.org/maplibre-gl-js/docs/examples/change-case-of-labels/)\n\n - [Display HTML clusters with custom properties](https://maplibre.org/maplibre-gl-js/docs/examples/display-html-clusters-with-custom-properties/)\n\n - [Extrude polygons for 3D indoor mapping](https://maplibre.org/maplibre-gl-js/docs/examples/extrude-polygons-for-3d-indoor-mapping/)",
"syntax": {
"overloads": [
{
"parameters": ["property_name", "object?"],
"output-type": "any"
}
],
"parameters": [
{
"name": "property_name",
"type": "string",
"description": "The name of the property to retrieve the value of."
},
{
"name": "object",
"type": "object",
"description": "The object to retrieve the value from."
}
]
},
"example": ["get", "someProperty"],
"group": "Lookup",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"has": {
"doc": "Tests for the presence of a property value in the current feature's properties, or from another object if a second argument is provided.\n\n - [Create and style clusters](https://maplibre.org/maplibre-gl-js/docs/examples/create-and-style-clusters/)",
"syntax": {
"overloads": [
{
"parameters": ["property_name", "object?"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "property_name",
"type": "string",
"description": "The name of the property to test for the presence of."
},
{
"name": "object",
"type": "object",
"description": "The object in which to test for the presence of the `property_name` property."
}
]
},
"example": ["has", "someProperty"],
"group": "Lookup",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"length": {
"doc": "Gets the length of an array or string. In a string, a UTF-16 surrogate pair counts as a single position.",
"syntax": {
"overloads": [
{
"parameters": ["array_or_string"],
"output-type": "number"
}
],
"parameters": [
{
"name": "array_or_string",
"type": "array | string"
}
]
},
"example": ["length", ["get", "myArray"]],
"group": "Lookup",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"properties": {
"doc": "Gets the feature properties object. Note that in some cases, it may be more efficient to use [\"get\", \"property_name\"] directly.",
"syntax": {
"overloads": [
{
"parameters": [],
"output-type": "object"
}
]
},
"example": ["properties"],
"group": "Feature data",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"feature-state": {
"doc": "Retrieves a property value from the current feature's state. Returns null if the requested property is not present on the feature's state. A feature's state is not part of the GeoJSON or vector tile data, and must be set programmatically on each feature. When `source.promoteId` is not provided, features are identified by their `id` attribute, which must be an integer or a string that can be cast to an integer. When `source.promoteId` is provided, features are identified by their `promoteId` property, which may be a number, string, or any primitive data type. Note that [\"feature-state\"] can only be used with paint properties that support data-driven styling.\n\n - [Create a hover effect](https://maplibre.org/maplibre-gl-js/docs/examples/create-a-hover-effect/)",
"syntax": {
"overloads": [
{
"parameters": ["property_name"],
"output-type": "any"
}
],
"parameters": [
{
"name": "property_name",
"type": "string"
}
]
},
"example": ["feature-state", "hover"],
"group": "Feature data",
"sdk-support": {
"basic functionality": {
"js": "0.46.0",
"ios": "https://github.com/maplibre/maplibre-native/issues/1698",
"android": "https://github.com/maplibre/maplibre-native/issues/1698"
}
}
},
"geometry-type": {
"doc": "Returns the feature's simple geometry type: `Point`, `LineString`, or `Polygon`. `MultiPoint`, `MultiLineString`, and `MultiPolygon` are returned as `Point`, `LineString`, and `Polygon`, respectively.",
"syntax": {
"overloads": [
{
"parameters": [],
"output-type": "string"
}
]
},
"example": ["==", ["geometry-type"], "Polygon"],
"group": "Feature data",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"id": {
"doc": "Gets the feature's id, if it has one.",
"syntax": {
"overloads": [
{
"parameters": [],
"output-type": "any"
}
]
},
"example": ["id"],
"group": "Feature data",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"zoom": {
"doc": "Gets the current zoom level. Note that in style layout and paint properties, [\"zoom\"] may only appear as the input to a top-level \"step\" or \"interpolate\" expression.",
"syntax": {
"overloads": [
{
"parameters": [],
"output-type": "number"
}
]
},
"example": ["interpolate", ["linear"], ["zoom"], 15, 0, 15.05, ["get", "height"]],
"group": "Zoom",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"heatmap-density": {
"doc": "Gets the kernel density estimation of a pixel in a heatmap layer, which is a relative measure of how many data points are crowded around a particular pixel. Can only be used in the `heatmap-color` property.",
"syntax": {
"overloads": [
{
"parameters": [],
"output-type": "number"
}
]
},
"example": ["heatmap-density"],
"group": "Heatmap",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"elevation": {
"doc": "Gets the elevation of a pixel (in meters above the vertical datum reference of the `raster-dem` tiles) from a `raster-dem` source. Can only be used in the `color-relief-color` property of a `color-relief` layer.",
"syntax": {
"overloads": [
{
"parameters": [],
"output-type": "number"
}
]
},
"example": ["elevation"],
"group": "Color Relief",
"sdk-support": {
"basic functionality": {
"js": "5.6.0",
"android": "https://github.com/maplibre/maplibre-native/issues/3408",
"ios": "https://github.com/maplibre/maplibre-native/issues/3408"
}
}
},
"line-progress": {
"doc": "Gets the progress along a gradient line. Can only be used in the `line-gradient` property.",
"syntax": {
"overloads": [
{
"parameters": [],
"output-type": "number"
}
]
},
"example": ["line-progress"],
"group": "Feature data",
"sdk-support": {
"basic functionality": {
"js": "0.45.0",
"android": "6.5.0",
"ios": "4.6.0"
}
}
},
"accumulated": {
"doc": "Gets the value of a cluster property accumulated so far. Can only be used in the `clusterProperties` option of a clustered GeoJSON source.",
"syntax": {
"overloads": [
{
"parameters": [],
"output-type": "any"
}
]
},
"example": ["accumulated"],
"group": "Feature data",
"sdk-support": {
"basic functionality": {
"js": "0.53.0",
"ios": "supported",
"android": "supported"
}
}
},
"+": {
"doc": "Returns the sum of the inputs.",
"syntax": {
"overloads": [
{
"parameters": ["input_1", "...", "input_n"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input_i",
"type": "number"
}
]
},
"example": ["+", 2, 3],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"*": {
"doc": "Returns the product of the inputs.",
"syntax": {
"overloads": [
{
"parameters": ["input_1", "...", "input_n"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input_i",
"type": "number"
}
]
},
"example": ["*", 2, 3],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"-": {
"doc": "For two inputs, returns the result of subtracting the second input from the first. For a single input, returns the result of subtracting it from 0.",
"syntax": {
"overloads": [
{
"parameters": ["input_1", "input_2"],
"output-type": "number"
},
{
"parameters": ["single_input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input_1",
"type": "number",
"description": "The number from which to subtract `input_2`."
},
{
"name": "input_2",
"type": "number",
"description": "The number to subtract from `input_1`."
},
{
"name": "single_input",
"type": "number",
"description": "The number to subtract from 0."
}
]
},
"example": ["-", 10],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"/": {
"doc": "Returns the result of floating point division of the first input by the second.\n\n - [Visualize population density](https://maplibre.org/maplibre-gl-js/docs/examples/visualize-population-density/)",
"syntax": {
"overloads": [
{
"parameters": ["input_1", "input_2"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input_1",
"type": "number",
"description": "The dividend."
},
{
"name": "input_2",
"type": "number",
"description": "The divisor."
}
]
},
"example": ["/", ["get", "population"], ["get", "sq-km"]],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"%": {
"doc": "Returns the remainder after integer division of the first input by the second.",
"syntax": {
"overloads": [
{
"parameters": ["input_1", "input_2"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input_1",
"type": "number",
"description": "The dividend."
},
{
"name": "input_2",
"type": "number",
"description": "The divisor."
}
]
},
"example": ["%", 10, 3],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"^": {
"doc": "Returns the result of raising the first input to the power specified by the second.",
"syntax": {
"overloads": [
{
"parameters": ["input_1", "input_2"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input_1",
"type": "number",
"description": "The base."
},
{
"name": "input_2",
"type": "number",
"description": "The exponent."
}
]
},
"example": ["^", 2, 3],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"sqrt": {
"doc": "Returns the square root of the input.",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input",
"type": "number",
"description": "The radicand."
}
]
},
"example": ["sqrt", 9],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.42.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"log10": {
"doc": "Returns the base-ten logarithm of the input.",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input",
"type": "number"
}
]
},
"example": ["log10", 8],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"ln": {
"doc": "Returns the natural logarithm of the input.",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input",
"type": "number"
}
]
},
"example": ["ln", 8],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"log2": {
"doc": "Returns the base-two logarithm of the input.",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input",
"type": "number"
}
]
},
"example": ["log2", 8],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"sin": {
"doc": "Returns the sine of the input.",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input",
"type": "number"
}
]
},
"example": ["sin", 1],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"cos": {
"doc": "Returns the cosine of the input.",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input",
"type": "number"
}
]
},
"example": ["cos", 1],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"tan": {
"doc": "Returns the tangent of the input.",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input",
"type": "number"
}
]
},
"example": ["tan", 1],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"asin": {
"doc": "Returns the arcsine of the input.",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input",
"type": "number"
}
]
},
"example": ["asin", 1],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"acos": {
"doc": "Returns the arccosine of the input.",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input",
"type": "number"
}
]
},
"example": ["acos", 1],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"atan": {
"doc": "Returns the arctangent of the input.",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input",
"type": "number"
}
]
},
"example": ["atan", 1],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"min": {
"doc": "Returns the minimum value of the inputs.",
"syntax": {
"overloads": [
{
"parameters": ["input_1", "...", "input_n"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input_i",
"type": "number"
}
]
},
"example": ["min", 1, 2],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"max": {
"doc": "Returns the maximum value of the inputs.",
"syntax": {
"overloads": [
{
"parameters": ["input_1", "...", "input_n"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input_i",
"type": "number"
}
]
},
"example": ["max", 1, 2],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"round": {
"doc": "Rounds the input to the nearest integer. Halfway values are rounded away from zero. For example, `[\"round\", -1.5]` evaluates to -2.",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input",
"type": "number"
}
]
},
"example": ["round", 1.5],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.45.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"abs": {
"doc": "Returns the absolute value of the input.",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input",
"type": "number"
}
]
},
"example": ["abs", -1.5],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.45.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"ceil": {
"doc": "Returns the smallest integer that is greater than or equal to the input.",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input",
"type": "number"
}
]
},
"example": ["ceil", 1.5],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.45.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"floor": {
"doc": "Returns the largest integer that is less than or equal to the input.",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "number"
}
],
"parameters": [
{
"name": "input",
"type": "number"
}
]
},
"example": ["floor", 1.5],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "0.45.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"distance": {
"doc": "Returns the shortest distance in meters between the evaluated feature and the input geometry. The input value can be a valid GeoJSON of type `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, `Feature`, or `FeatureCollection`. Distance values returned may vary in precision due to loss in precision from encoding geometries, particularly below zoom level 13.",
"syntax": {
"overloads": [
{
"parameters": ["geojson"],
"output-type": "number"
}
],
"parameters": [
{
"name": "geojson",
"type": "GeoJSON object"
}
]
},
"example": ["distance", {"type": "Point", "coordinates": [0, 0]}],
"group": "Math",
"sdk-support": {
"basic functionality": {
"js": "4.2.0",
"android": "9.2.0",
"ios": "5.9.0"
}
}
},
"==": {
"doc": "Returns `true` if the input values are equal, `false` otherwise. The comparison is strictly typed: values of different runtime types are always considered unequal. Cases where the types are known to be different at parse time are considered invalid and will produce a parse error. Accepts an optional `collator` argument to control locale-dependent string comparisons.\n\n - [Add multiple geometries from one GeoJSON source](https://maplibre.org/maplibre-gl-js/docs/examples/multiple-geometries/)\n\n - [Create a time slider](https://maplibre.org/maplibre-gl-js/docs/examples/timeline-animation/)\n\n - [Display buildings in 3D](https://maplibre.org/maplibre-gl-js/docs/examples/display-buildings-in-3d/)\n\n - [Filter symbols by toggling a list](https://maplibre.org/maplibre-gl-js/docs/examples/filter-symbols-by-toggling-a-list/)",
"syntax": {
"overloads": [
{
"parameters": ["input_1", "input_2", "collator?"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "input_1",
"type": "any"
},
{
"name": "input_2",
"type": "any"
},
{
"name": "collator",
"type": "collator",
"description": "Options for locale-dependent comparison."
}
]
},
"example": ["==", "$type", "Polygon"],
"group": "Decision",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
},
"collator": {
"js": "0.45.0",
"android": "6.5.0",
"ios": "4.2.0"
}
}
},
"!=": {
"doc": "Returns `true` if the input values are not equal, `false` otherwise. The comparison is strictly typed: values of different runtime types are always considered unequal. Cases where the types are known to be different at parse time are considered invalid and will produce a parse error. Accepts an optional `collator` argument to control locale-dependent string comparisons.\n\n - [Display HTML clusters with custom properties](https://maplibre.org/maplibre-gl-js/docs/examples/display-html-clusters-with-custom-properties/)",
"syntax": {
"overloads": [
{
"parameters": ["input_1", "input_2", "collator?"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "input_1",
"type": "any"
},
{
"name": "input_2",
"type": "any"
},
{
"name": "collator",
"type": "collator",
"description": "Options for locale-dependent comparison."
}
]
},
"example": ["!=", "cluster", true],
"group": "Decision",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
},
"collator": {
"js": "0.45.0",
"android": "6.5.0",
"ios": "4.2.0"
}
}
},
">": {
"doc": "Returns `true` if the first input is strictly greater than the second, `false` otherwise. The arguments are required to be either both strings or both numbers; if during evaluation they are not, expression evaluation produces an error. Cases where this constraint is known not to hold at parse time are considered in valid and will produce a parse error. Accepts an optional `collator` argument to control locale-dependent string comparisons.",
"syntax": {
"overloads": [
{
"parameters": ["string_1", "string_2", "collator?"],
"output-type": "boolean"
},
{
"parameters": ["number_1", "number_2", "collator?"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "string_i",
"type": "string"
},
{
"name": "number_i",
"type": "number"
},
{
"name": "collator",
"type": "collator",
"description": "Options for locale-dependent comparison."
}
]
},
"example": [">", ["get", "mag"], 2],
"group": "Decision",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
},
"collator": {
"js": "0.45.0",
"android": "6.5.0",
"ios": "4.2.0"
}
}
},
"<": {
"doc": "Returns `true` if the first input is strictly less than the second, `false` otherwise. The arguments are required to be either both strings or both numbers; if during evaluation they are not, expression evaluation produces an error. Cases where this constraint is known not to hold at parse time are considered in valid and will produce a parse error. Accepts an optional `collator` argument to control locale-dependent string comparisons.\n\n - [Display HTML clusters with custom properties](https://maplibre.org/maplibre-gl-js/docs/examples/display-html-clusters-with-custom-properties/)",
"syntax": {
"overloads": [
{
"parameters": ["string_1", "string_2", "collator?"],
"output-type": "boolean"
},
{
"parameters": ["number_1", "number_2", "collator?"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "string_i",
"type": "string"
},
{
"name": "number_i",
"type": "number"
},
{
"name": "collator",
"type": "collator",
"description": "Options for locale-dependent comparison."
}
]
},
"example": ["<", ["get", "mag"], 2],
"group": "Decision",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
},
"collator": {
"js": "0.45.0",
"android": "6.5.0",
"ios": "4.2.0"
}
}
},
">=": {
"doc": "Returns `true` if the first input is greater than or equal to the second, `false` otherwise. The arguments are required to be either both strings or both numbers; if during evaluation they are not, expression evaluation produces an error. Cases where this constraint is known not to hold at parse time are considered in valid and will produce a parse error. Accepts an optional `collator` argument to control locale-dependent string comparisons.\n\n - [Display HTML clusters with custom properties](https://maplibre.org/maplibre-gl-js/docs/examples/display-html-clusters-with-custom-properties/)",
"syntax": {
"overloads": [
{
"parameters": ["string_1", "string_2", "collator?"],
"output-type": "boolean"
},
{
"parameters": ["number_1", "number_2", "collator?"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "string_i",
"type": "string"
},
{
"name": "number_i",
"type": "number"
},
{
"name": "collator",
"type": "collator",
"description": "Options for locale-dependent comparison."
}
]
},
"example": [">=", ["get", "mag"], 6],
"group": "Decision",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
},
"collator": {
"js": "0.45.0",
"android": "6.5.0",
"ios": "4.2.0"
}
}
},
"<=": {
"doc": "Returns `true` if the first input is less than or equal to the second, `false` otherwise. The arguments are required to be either both strings or both numbers; if during evaluation they are not, expression evaluation produces an error. Cases where this constraint is known not to hold at parse time are considered in valid and will produce a parse error. Accepts an optional `collator` argument to control locale-dependent string comparisons.",
"syntax": {
"overloads": [
{
"parameters": ["string_1", "string_2", "collator?"],
"output-type": "boolean"
},
{
"parameters": ["number_1", "number_2", "collator?"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "string_i",
"type": "string"
},
{
"name": "number_i",
"type": "number"
},
{
"name": "collator",
"type": "collator",
"description": "Options for locale-dependent comparison."
}
]
},
"example": ["<=", ["get", "mag"], 6],
"group": "Decision",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
},
"collator": {
"js": "0.45.0",
"android": "6.5.0",
"ios": "4.2.0"
}
}
},
"all": {
"doc": "Returns `true` if all the inputs are `true`, `false` otherwise. The inputs are evaluated in order, and evaluation is short-circuiting: once an input expression evaluates to `false`, the result is `false` and no further input expressions are evaluated.\n\n - [Display HTML clusters with custom properties](https://maplibre.org/maplibre-gl-js/docs/examples/display-html-clusters-with-custom-properties/)",
"syntax": {
"overloads": [
{
"parameters": ["input_1", "...", "input_n"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "input_i",
"type": "boolean"
}
]
},
"example": ["all", [">=", ["get", "mag"], 4], ["<", ["get", "mag"], 5]],
"group": "Decision",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"any": {
"doc": "Returns `true` if any of the inputs are `true`, `false` otherwise. The inputs are evaluated in order, and evaluation is short-circuiting: once an input expression evaluates to `true`, the result is `true` and no further input expressions are evaluated.",
"syntax": {
"overloads": [
{
"parameters": ["input_1", "...", "input_n"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "input_i",
"type": "boolean"
}
]
},
"example": ["any", [">=", ["get", "mag"], 4], ["<", ["get", "mag"], 5]],
"group": "Decision",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"!": {
"doc": "Logical negation. Returns `true` if the input is `false`, and `false` if the input is `true`.\n\n - [Create and style clusters](https://maplibre.org/maplibre-gl-js/docs/examples/create-and-style-clusters/)",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "input",
"type": "boolean"
}
]
},
"example": ["!", ["has", "point_count"]],
"group": "Decision",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"within": {
"doc": "Returns `true` if the evaluated feature is fully contained inside a boundary of the input geometry, `false` otherwise. The input value can be a valid GeoJSON of type `Polygon`, `MultiPolygon`, `Feature`, or `FeatureCollection`. Supported features for evaluation:\n\n- `Point`: Returns `false` if a point is on the boundary or falls outside the boundary.\n\n- `LineString`: Returns `false` if any part of a line falls outside the boundary, the line intersects the boundary, or a line's endpoint is on the boundary.",
"syntax": {
"overloads": [
{
"parameters": ["geojson"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "geojson",
"type": "GeoJSON object"
}
]
},
"example": ["within", {"type": "Polygon", "coordinates": [[[0, 0], [0, 5], [5, 5], [5, 0], [0, 0]]]}],
"group": "Decision",
"sdk-support": {
"basic functionality": {
"js": "1.9.0",
"android": "9.1.0",
"ios": "5.8.0"
}
}
},
"is-supported-script": {
"doc": "Returns `true` if the input string is expected to render legibly. Returns `false` if the input string contains sections that cannot be rendered without potential loss of meaning (e.g. Indic scripts that require complex text shaping, or right-to-left scripts if the `mapbox-gl-rtl-text` plugin is not in use in MapLibre GL JS).",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "boolean"
}
],
"parameters": [
{
"name": "input",
"type": "string"
}
]
},
"example": ["is-supported-script", "दिल्ली"],
"group": "String",
"sdk-support": {
"basic functionality": {
"js": "0.45.0",
"android": "6.6.0",
"ios": "supported"
}
}
},
"upcase": {
"doc": "Returns the input string converted to uppercase. Follows the Unicode Default Case Conversion algorithm and the locale-insensitive case mappings in the Unicode Character Database.\n\n - [Change the case of labels](https://maplibre.org/maplibre-gl-js/docs/examples/change-case-of-labels/)",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "string"
}
],
"parameters": [
{
"name": "input",
"type": "string"
}
]
},
"example": ["upcase", ["get", "name"]],
"group": "String",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"downcase": {
"doc": "Returns the input string converted to lowercase. Follows the Unicode Default Case Conversion algorithm and the locale-insensitive case mappings in the Unicode Character Database.\n\n - [Change the case of labels](https://maplibre.org/maplibre-gl-js/docs/examples/change-case-of-labels/)",
"syntax": {
"overloads": [
{
"parameters": ["input"],
"output-type": "string"
}
],
"parameters": [
{
"name": "input",
"type": "string"
}
]
},
"example": ["downcase", ["get", "name"]],
"group": "String",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"concat": {
"doc": "Returns a `string` consisting of the concatenation of the inputs. Each input is converted to a string as if by `to-string`.\n\n - [Add a generated icon to the map](https://maplibre.org/maplibre-gl-js/docs/examples/add-a-generated-icon-to-the-map/)\n\n - [Create a time slider](https://maplibre.org/maplibre-gl-js/docs/examples/create-a-time-slider/)\n\n - [Use a fallback image](https://maplibre.org/maplibre-gl-js/docs/examples/fallback-image/)\n\n - [Variable label placement](https://maplibre.org/maplibre-gl-js/docs/examples/variable-label-placement/)",
"syntax": {
"overloads": [
{
"parameters": ["input_1", "...", "input_n"],
"output-type": "string"
}
],
"parameters": [
{
"name": "input_i",
"type": "any"
}
]
},
"example": ["concat", "square-rgb-", ["get", "color"]],
"group": "String",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
}
},
"resolved-locale": {
"doc": "Returns the IETF language tag of the locale being used by the provided `collator`. This can be used to determine the default system locale, or to determine if a requested locale was successfully loaded.",
"syntax": {
"overloads": [
{
"parameters": ["collator"],
"output-type": "string"
}
],
"parameters": [
{
"name": "collator",
"type": "collator"
}
]
},
"example": ["resolved-locale", [
"collator",
{"case-sensitive": true, "diacritic-sensitive": false, "locale": "de"}
]],
"group": "String",
"sdk-support": {
"basic functionality": {
"js": "0.45.0",
"android": "6.5.0",
"ios": "4.2.0"
}
}
}
}
},
"light": {
"anchor": {
"type": "enum",
"default": "viewport",
"values": {
"map": {
"doc": "The position of the light source is aligned to the rotation of the map."
},
"viewport": {
"doc": "The position of the light source is aligned to the rotation of the viewport."
}
},
"property-type": "data-constant",
"transition": false,
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"doc": "Whether extruded geometries are lit relative to the map or viewport.",
"example": "map",
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0"
}
}
},
"position": {
"type": "array",
"default": [
1.15,
210,
30
],
"length": 3,
"value": "number",
"property-type": "data-constant",
"transition": true,
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"doc": "Position of the light source relative to lit (extruded) geometries, in [r radial coordinate, a azimuthal angle, p polar angle] where r indicates the distance from the center of the base of an object to its light, a indicates the position of the light relative to 0° (0° when `light.anchor` is set to `viewport` corresponds to the top of the viewport, or 0° when `light.anchor` is set to `map` corresponds to due north, and degrees proceed clockwise), and p indicates the height of the light (from 0°, directly above, to 180°, directly below).",
"example": [
1.5,
90,
80
],
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0"
}
}
},
"color": {
"type": "color",
"property-type": "data-constant",
"default": "#ffffff",
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "Color tint for lighting extruded geometries.",
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0"
}
}
},
"intensity": {
"type": "number",
"property-type": "data-constant",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast.",
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0"
}
}
}
},
"sky": {
"sky-color": {
"type": "color",
"property-type": "data-constant",
"default": "#88C6FC",
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "The base color for the sky."
},
"horizon-color": {
"type": "color",
"property-type": "data-constant",
"default": "#ffffff",
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "The base color at the horizon."
},
"fog-color": {
"type": "color",
"property-type": "data-constant",
"default": "#ffffff",
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "The base color for the fog. Requires 3D terrain."
},
"fog-ground-blend": {
"type": "number",
"property-type": "data-constant",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "How to blend the fog over the 3D terrain. Where 0 is the map center and 1 is the horizon."
},
"horizon-fog-blend": {
"type": "number",
"property-type": "data-constant",
"default": 0.8,
"minimum": 0,
"maximum": 1,
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "How to blend the fog color and the horizon color. Where 0 is using the horizon color only and 1 is using the fog color only."
},
"sky-horizon-blend": {
"type": "number",
"property-type": "data-constant",
"default": 0.8,
"minimum": 0,
"maximum": 1,
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "How to blend the sky color and the horizon color. Where 1 is blending the color at the middle of the sky and 0 is not blending at all and using the sky color only."
},
"atmosphere-blend": {
"type": "number",
"property-type": "data-constant",
"default": 0.8,
"minimum": 0,
"maximum": 1,
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "How to blend the atmosphere. Where 1 is visible atmosphere and 0 is hidden. It is best to interpolate this expression when using globe projection."
}
},
"terrain": {
"source": {
"type": "string",
"doc": "The source for the terrain data.",
"required": true,
"sdk-support": {
"basic functionality": {
"js": "2.2.0",
"ios": "https://github.com/maplibre/maplibre-native/issues/252",
"android": "https://github.com/maplibre/maplibre-native/issues/252"
}
}
},
"exaggeration": {
"type": "number",
"minimum": 0,
"doc": "The exaggeration of the terrain - how high it will look.",
"default": 1.0,
"sdk-support": {
"basic functionality": {
"js": "2.2.0",
"ios": "https://github.com/maplibre/maplibre-native/issues/252",
"android": "https://github.com/maplibre/maplibre-native/issues/252"
}
}
}
},
"projection": {
"type": {
"type": "projectionDefinition",
"doc": "The projection definition type. Can be specified as a string, a transition state, or an expression.",
"default": "mercator",
"property-type": "data-constant",
"transition": false,
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
}
}
},
"paint": [
"paint_fill",
"paint_line",
"paint_circle",
"paint_heatmap",
"paint_fill-extrusion",
"paint_symbol",
"paint_raster",
"paint_hillshade",
"paint_color-relief",
"paint_background"
],
"paint_fill": {
"fill-antialias": {
"type": "boolean",
"default": true,
"doc": "Whether or not the fill should be antialiased.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"fill-opacity": {
"type": "number",
"default": 1,
"minimum": 0,
"maximum": 1,
"doc": "The opacity of the entire fill layer. In contrast to the `fill-color`, this value will also affect the 1px stroke around the fill, if the stroke is used.",
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.21.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"fill-color": {
"type": "color",
"default": "#000000",
"doc": "The color of the filled part of this layer. This color can be specified as `rgba` with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.",
"transition": true,
"requires": [
{
"!": "fill-pattern"
}
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.19.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"fill-outline-color": {
"type": "color",
"doc": "The outline color of the fill. Matches the value of `fill-color` if unspecified.",
"transition": true,
"requires": [
{
"!": "fill-pattern"
},
{
"fill-antialias": true
}
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.19.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"fill-translate": {
"type": "array",
"value": "number",
"length": 2,
"default": [
0,
0
],
"transition": true,
"units": "pixels",
"doc": "The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"fill-translate-anchor": {
"type": "enum",
"values": {
"map": {
"doc": "The fill is translated relative to the map."
},
"viewport": {
"doc": "The fill is translated relative to the viewport."
}
},
"doc": "Controls the frame of reference for `fill-translate`.",
"default": "map",
"requires": [
"fill-translate"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"fill-pattern": {
"type": "resolvedImage",
"transition": true,
"doc": "Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.49.0",
"android": "6.5.0",
"ios": "4.4.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom",
"feature"
]
},
"property-type": "cross-faded-data-driven"
}
},
"paint_fill-extrusion": {
"fill-extrusion-opacity": {
"type": "number",
"default": 1,
"minimum": 0,
"maximum": 1,
"doc": "The opacity of the entire fill extrusion layer. This is rendered on a per-layer, not per-feature, basis, and data-driven styling is not available.",
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"fill-extrusion-color": {
"type": "color",
"default": "#000000",
"doc": "The base color of the extruded fill. The extrusion's surfaces will be shaded differently based on this color in combination with the root `light` settings. If this color is specified as `rgba` with an alpha component, the alpha component will be ignored; use `fill-extrusion-opacity` to set layer opacity.",
"transition": true,
"requires": [
{
"!": "fill-extrusion-pattern"
}
],
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0"
},
"data-driven styling": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"fill-extrusion-translate": {
"type": "array",
"value": "number",
"length": 2,
"default": [
0,
0
],
"transition": true,
"units": "pixels",
"doc": "The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.",
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"fill-extrusion-translate-anchor": {
"type": "enum",
"values": {
"map": {
"doc": "The fill extrusion is translated relative to the map."
},
"viewport": {
"doc": "The fill extrusion is translated relative to the viewport."
}
},
"doc": "Controls the frame of reference for `fill-extrusion-translate`.",
"default": "map",
"requires": [
"fill-extrusion-translate"
],
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"fill-extrusion-pattern": {
"type": "resolvedImage",
"transition": true,
"doc": "Name of image in sprite to use for drawing images on extruded fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.",
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0"
},
"data-driven styling": {
"js": "0.49.0",
"android": "6.5.0",
"ios": "4.4.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom",
"feature"
]
},
"property-type": "cross-faded-data-driven"
},
"fill-extrusion-height": {
"type": "number",
"default": 0,
"minimum": 0,
"units": "meters",
"doc": "The height with which to extrude this layer.",
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0"
},
"data-driven styling": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"fill-extrusion-base": {
"type": "number",
"default": 0,
"minimum": 0,
"units": "meters",
"doc": "The height with which to extrude the base of this layer. Must be less than or equal to `fill-extrusion-height`.",
"transition": true,
"requires": [
"fill-extrusion-height"
],
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0"
},
"data-driven styling": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"fill-extrusion-vertical-gradient": {
"type": "boolean",
"default": true,
"doc": "Whether to apply a vertical gradient to the sides of a fill-extrusion layer. If true, sides will be shaded slightly darker farther down.",
"transition": false,
"sdk-support": {
"basic functionality": {
"js": "0.50.0",
"ios": "4.7.0",
"android": "7.0.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
}
},
"paint_line": {
"line-opacity": {
"type": "number",
"doc": "The opacity at which the line will be drawn.",
"default": 1,
"minimum": 0,
"maximum": 1,
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.29.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"line-color": {
"type": "color",
"doc": "The color with which the line will be drawn.",
"default": "#000000",
"transition": true,
"requires": [
{
"!": "line-pattern"
}
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.23.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"line-translate": {
"type": "array",
"value": "number",
"length": 2,
"default": [
0,
0
],
"transition": true,
"units": "pixels",
"doc": "The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"line-translate-anchor": {
"type": "enum",
"values": {
"map": {
"doc": "The line is translated relative to the map."
},
"viewport": {
"doc": "The line is translated relative to the viewport."
}
},
"doc": "Controls the frame of reference for `line-translate`.",
"default": "map",
"requires": [
"line-translate"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"line-width": {
"type": "number",
"default": 1,
"minimum": 0,
"transition": true,
"units": "pixels",
"doc": "Stroke thickness.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.39.0",
"android": "5.2.0",
"ios": "3.7.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"line-gap-width": {
"type": "number",
"default": 0,
"minimum": 0,
"doc": "Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.",
"transition": true,
"units": "pixels",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.29.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"line-offset": {
"type": "number",
"default": 0,
"doc": "The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.",
"transition": true,
"units": "pixels",
"sdk-support": {
"basic functionality": {
"js": "0.12.1",
"android": "3.0.0",
"ios": "3.1.0"
},
"data-driven styling": {
"js": "0.29.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"line-blur": {
"type": "number",
"default": 0,
"minimum": 0,
"transition": true,
"units": "pixels",
"doc": "Blur applied to the line, in pixels.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.29.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"line-dasharray": {
"type": "array",
"value": "number",
"doc": "Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to pixels, multiply the length by the current line width. GeoJSON sources with `lineMetrics: true` specified won't render dashed lines to the expected scale. Zoom-dependent expressions will be evaluated only at integer zoom levels. The only way to create an array value is using `[\"literal\", [...]]`; arrays cannot be read from or derived from feature properties.",
"minimum": 0,
"transition": true,
"units": "line widths",
"requires": [
{
"!": "line-pattern"
}
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "https://github.com/maplibre/maplibre-gl-js/issues/1235",
"ios": "https://github.com/maplibre/maplibre-native/issues/744",
"android": "https://github.com/maplibre/maplibre-native/issues/744"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom",
"feature"
]
},
"property-type": "cross-faded-data-driven"
},
"line-pattern": {
"type": "resolvedImage",
"transition": true,
"doc": "Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.49.0",
"android": "6.5.0",
"ios": "4.4.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom",
"feature"
]
},
"property-type": "cross-faded-data-driven"
},
"line-gradient": {
"type": "color",
"doc": "Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify `\"lineMetrics\": true`.",
"transition": false,
"requires": [
{
"!": "line-dasharray"
},
{
"!": "line-pattern"
},
{
"source": "geojson",
"has": {
"lineMetrics": true
}
}
],
"sdk-support": {
"basic functionality": {
"js": "0.45.0",
"android": "6.5.0",
"ios": "4.4.0"
},
"data-driven styling": {}
},
"expression": {
"interpolated": true,
"parameters": [
"line-progress"
]
},
"property-type": "color-ramp"
}
},
"paint_circle": {
"circle-radius": {
"type": "number",
"default": 5,
"minimum": 0,
"transition": true,
"units": "pixels",
"doc": "Circle radius.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.18.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"circle-color": {
"type": "color",
"default": "#000000",
"doc": "The fill color of the circle.",
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.18.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"circle-blur": {
"type": "number",
"default": 0,
"doc": "Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.",
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.20.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"circle-opacity": {
"type": "number",
"doc": "The opacity at which the circle will be drawn.",
"default": 1,
"minimum": 0,
"maximum": 1,
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.20.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"circle-translate": {
"type": "array",
"value": "number",
"length": 2,
"default": [
0,
0
],
"transition": true,
"units": "pixels",
"doc": "The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"circle-translate-anchor": {
"type": "enum",
"values": {
"map": {
"doc": "The circle is translated relative to the map."
},
"viewport": {
"doc": "The circle is translated relative to the viewport."
}
},
"doc": "Controls the frame of reference for `circle-translate`.",
"default": "map",
"requires": [
"circle-translate"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"circle-pitch-scale": {
"type": "enum",
"values": {
"map": {
"doc": "Circles are scaled according to their apparent distance to the camera."
},
"viewport": {
"doc": "Circles are not scaled."
}
},
"default": "map",
"doc": "Controls the scaling behavior of the circle when the map is pitched.",
"sdk-support": {
"basic functionality": {
"js": "0.21.0",
"android": "4.2.0",
"ios": "3.4.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"circle-pitch-alignment": {
"type": "enum",
"values": {
"map": {
"doc": "The circle is aligned to the plane of the map."
},
"viewport": {
"doc": "The circle is aligned to the plane of the viewport."
}
},
"default": "viewport",
"doc": "Orientation of circle when map is pitched.",
"sdk-support": {
"basic functionality": {
"js": "0.39.0",
"android": "5.2.0",
"ios": "3.7.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"circle-stroke-width": {
"type": "number",
"default": 0,
"minimum": 0,
"transition": true,
"units": "pixels",
"doc": "The width of the circle's stroke. Strokes are placed outside of the `circle-radius`.",
"sdk-support": {
"basic functionality": {
"js": "0.29.0",
"android": "5.0.0",
"ios": "3.5.0"
},
"data-driven styling": {
"js": "0.29.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"circle-stroke-color": {
"type": "color",
"default": "#000000",
"doc": "The stroke color of the circle.",
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.29.0",
"android": "5.0.0",
"ios": "3.5.0"
},
"data-driven styling": {
"js": "0.29.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"circle-stroke-opacity": {
"type": "number",
"doc": "The opacity of the circle's stroke.",
"default": 1,
"minimum": 0,
"maximum": 1,
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.29.0",
"android": "5.0.0",
"ios": "3.5.0"
},
"data-driven styling": {
"js": "0.29.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
}
},
"paint_heatmap": {
"heatmap-radius": {
"type": "number",
"default": 30,
"minimum": 1,
"transition": true,
"units": "pixels",
"doc": "Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed.",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
},
"data-driven styling": {
"js": "0.43.0",
"android": "6.0.0",
"ios": "4.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"heatmap-weight": {
"type": "number",
"default": 1,
"minimum": 0,
"transition": false,
"doc": "A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
},
"data-driven styling": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"heatmap-intensity": {
"type": "number",
"default": 1,
"minimum": 0,
"transition": true,
"doc": "Similar to `heatmap-weight` but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.",
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"heatmap-color": {
"type": "color",
"default": [
"interpolate",
[
"linear"
],
[
"heatmap-density"
],
0,
"rgba(0, 0, 255, 0)",
0.1,
"royalblue",
0.3,
"cyan",
0.5,
"lime",
0.7,
"yellow",
1,
"red"
],
"doc": "Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses `[\"heatmap-density\"]` as input.",
"transition": false,
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
},
"data-driven styling": {}
},
"expression": {
"interpolated": true,
"parameters": [
"heatmap-density"
]
},
"property-type": "color-ramp"
},
"heatmap-opacity": {
"type": "number",
"doc": "The global opacity at which the heatmap layer will be drawn.",
"default": 1,
"minimum": 0,
"maximum": 1,
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.41.0",
"android": "6.0.0",
"ios": "4.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
}
},
"paint_symbol": {
"icon-opacity": {
"doc": "The opacity at which the icon will be drawn.",
"type": "number",
"default": 1,
"minimum": 0,
"maximum": 1,
"transition": true,
"requires": [
"icon-image"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.33.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"icon-color": {
"type": "color",
"default": "#000000",
"transition": true,
"doc": "The color of the icon. This can only be used with SDF icons.",
"requires": [
"icon-image"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.33.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"icon-halo-color": {
"type": "color",
"default": "rgba(0, 0, 0, 0)",
"transition": true,
"doc": "The color of the icon's halo. Icon halos can only be used with SDF icons.",
"requires": [
"icon-image"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.33.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"icon-halo-width": {
"type": "number",
"default": 0,
"minimum": 0,
"transition": true,
"units": "pixels",
"doc": "Distance of halo to the icon outline. \n\nThe unit is in pixels only for SDF sprites that were created with a blur radius of 8, multiplied by the display density. I.e., the radius needs to be 16 for `@2x` sprites, etc.",
"requires": [
"icon-image"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.33.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"icon-halo-blur": {
"type": "number",
"default": 0,
"minimum": 0,
"transition": true,
"units": "pixels",
"doc": "Fade out the halo towards the outside.",
"requires": [
"icon-image"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.33.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"icon-translate": {
"type": "array",
"value": "number",
"length": 2,
"default": [
0,
0
],
"transition": true,
"units": "pixels",
"doc": "Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.",
"requires": [
"icon-image"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"icon-translate-anchor": {
"type": "enum",
"values": {
"map": {
"doc": "Icons are translated relative to the map."
},
"viewport": {
"doc": "Icons are translated relative to the viewport."
}
},
"doc": "Controls the frame of reference for `icon-translate`.",
"default": "map",
"requires": [
"icon-image",
"icon-translate"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"text-opacity": {
"type": "number",
"doc": "The opacity at which the text will be drawn.",
"default": 1,
"minimum": 0,
"maximum": 1,
"transition": true,
"requires": [
"text-field"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.33.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"text-color": {
"type": "color",
"doc": "The color with which the text will be drawn.",
"default": "#000000",
"transition": true,
"overridable": true,
"requires": [
"text-field"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.33.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"text-halo-color": {
"type": "color",
"default": "rgba(0, 0, 0, 0)",
"transition": true,
"doc": "The color of the text's halo, which helps it stand out from backgrounds.",
"requires": [
"text-field"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.33.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"text-halo-width": {
"type": "number",
"default": 0,
"minimum": 0,
"transition": true,
"units": "pixels",
"doc": "Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.",
"requires": [
"text-field"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.33.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"text-halo-blur": {
"type": "number",
"default": 0,
"minimum": 0,
"transition": true,
"units": "pixels",
"doc": "The halo's fadeout distance towards the outside.",
"requires": [
"text-field"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {
"js": "0.33.0",
"android": "5.0.0",
"ios": "3.5.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom",
"feature",
"feature-state"
]
},
"property-type": "data-driven"
},
"text-translate": {
"type": "array",
"value": "number",
"length": 2,
"default": [
0,
0
],
"transition": true,
"units": "pixels",
"doc": "Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.",
"requires": [
"text-field"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"text-translate-anchor": {
"type": "enum",
"values": {
"map": {
"doc": "The text is translated relative to the map."
},
"viewport": {
"doc": "The text is translated relative to the viewport."
}
},
"doc": "Controls the frame of reference for `text-translate`.",
"default": "map",
"requires": [
"text-field",
"text-translate"
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
}
},
"paint_raster": {
"raster-opacity": {
"type": "number",
"doc": "The opacity at which the image will be drawn.",
"default": 1,
"minimum": 0,
"maximum": 1,
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"raster-hue-rotate": {
"type": "number",
"default": 0,
"period": 360,
"transition": true,
"units": "degrees",
"doc": "Rotates hues around the color wheel.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"raster-brightness-min": {
"type": "number",
"doc": "Increase or reduce the brightness of the image. The value is the minimum brightness.",
"default": 0,
"minimum": 0,
"maximum": 1,
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"raster-brightness-max": {
"type": "number",
"doc": "Increase or reduce the brightness of the image. The value is the maximum brightness.",
"default": 1,
"minimum": 0,
"maximum": 1,
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"raster-saturation": {
"type": "number",
"doc": "Increase or reduce the saturation of the image.",
"default": 0,
"minimum": -1,
"maximum": 1,
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"raster-contrast": {
"type": "number",
"doc": "Increase or reduce the contrast of the image.",
"default": 0,
"minimum": -1,
"maximum": 1,
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"raster-resampling": {
"type": "enum",
"doc": "The resampling/interpolation method to use for overscaling, also known as texture magnification filter",
"values": {
"linear": {
"doc": "(Bi)linear filtering interpolates pixel values using the weighted average of the four closest original source pixels creating a smooth but blurry look when overscaled"
},
"nearest": {
"doc": "Nearest neighbor filtering interpolates pixel values using the nearest original source pixel creating a sharp but pixelated look when overscaled"
}
},
"default": "linear",
"sdk-support": {
"basic functionality": {
"js": "0.47.0",
"android": "6.3.0",
"ios": "4.2.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"raster-fade-duration": {
"type": "number",
"default": 300,
"minimum": 0,
"transition": false,
"units": "milliseconds",
"doc": "Fade duration when a new tile is added, or when a video is started or its coordinates are updated.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
}
},
"paint_hillshade": {
"hillshade-illumination-direction": {
"type": "numberArray",
"default": 335,
"minimum": 0,
"maximum": 359,
"doc": "The direction of the light source(s) used to generate the hillshading with 0 as the top of the viewport if `hillshade-illumination-anchor` is set to `viewport` and due north if `hillshade-illumination-anchor` is set to `map`. Only when `hillshade-method` is set to `multidirectional` can you specify multiple light sources.",
"transition": false,
"sdk-support": {
"basic functionality": {
"js": "0.43.0",
"android": "6.0.0",
"ios": "4.0.0"
},
"multidirectional": {
"js": "5.5.0",
"android": "https://github.com/maplibre/maplibre-native/issues/3396",
"ios": "https://github.com/maplibre/maplibre-native/issues/3396"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"hillshade-illumination-altitude": {
"type": "numberArray",
"default": 45,
"minimum": 0,
"maximum": 90,
"doc": "The altitude of the light source(s) used to generate the hillshading with 0 as sunset and 90 as noon. Only when `hillshade-method` is set to `multidirectional` can you specify multiple light sources.",
"transition": false,
"sdk-support": {
"basic functionality": {
"js": "5.5.0",
"android": "https://github.com/maplibre/maplibre-native/issues/3396",
"ios": "https://github.com/maplibre/maplibre-native/issues/3396"
},
"multidirectional": {
"js": "5.5.0",
"android": "https://github.com/maplibre/maplibre-native/issues/3396",
"ios": "https://github.com/maplibre/maplibre-native/issues/3396"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"hillshade-illumination-anchor": {
"type": "enum",
"values": {
"map": {
"doc": "The hillshade illumination is relative to the north direction."
},
"viewport": {
"doc": "The hillshade illumination is relative to the top of the viewport."
}
},
"default": "viewport",
"doc": "Direction of light source when map is rotated.",
"sdk-support": {
"basic functionality": {
"js": "0.43.0",
"android": "6.0.0",
"ios": "4.0.0"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"hillshade-exaggeration": {
"type": "number",
"doc": "Intensity of the hillshade",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.43.0",
"android": "6.0.0",
"ios": "4.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"hillshade-shadow-color": {
"type": "colorArray",
"default": "#000000",
"doc": "The shading color of areas that face away from the light source(s). Only when `hillshade-method` is set to `multidirectional` can you specify multiple light sources.",
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.43.0",
"android": "6.0.0",
"ios": "4.0.0"
},
"multidirectional": {
"js": "5.5.0",
"android": "https://github.com/maplibre/maplibre-native/issues/3396",
"ios": "https://github.com/maplibre/maplibre-native/issues/3396"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"hillshade-highlight-color": {
"type": "colorArray",
"default": "#FFFFFF",
"doc": "The shading color of areas that faces towards the light source(s). Only when `hillshade-method` is set to `multidirectional` can you specify multiple light sources.",
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.43.0",
"android": "6.0.0",
"ios": "4.0.0"
},
"multidirectional": {
"js": "5.5.0",
"android": "https://github.com/maplibre/maplibre-native/issues/3396",
"ios": "https://github.com/maplibre/maplibre-native/issues/3396"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"hillshade-accent-color": {
"type": "color",
"default": "#000000",
"doc": "The shading color used to accentuate rugged terrain like sharp cliffs and gorges.",
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.43.0",
"android": "6.0.0",
"ios": "4.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"hillshade-method": {
"type": "enum",
"values": {
"standard": {
"doc": "The legacy hillshade method."
},
"basic": {
"doc": "Basic hillshade. Uses a simple physics model where the reflected light intensity is proportional to the cosine of the angle between the incident light and the surface normal. Similar to GDAL's `gdaldem` default algorithm."
},
"combined": {
"doc": "Hillshade algorithm whose intensity scales with slope. Similar to GDAL's `gdaldem` with `-combined` option."
},
"igor": {
"doc": "Hillshade algorithm which tries to minimize effects on other map features beneath. Similar to GDAL's `gdaldem` with `-igor` option."
},
"multidirectional": {
"doc": "Hillshade with multiple illumination directions. Uses the basic hillshade model with multiple independent light sources."
}
},
"default": "standard",
"doc": "The hillshade algorithm to use, one of `standard`, `basic`, `combined`, `igor`, or `multidirectional`. ",
"sdk-support": {
"basic functionality": {
"js": "5.5.0",
"android": "https://github.com/maplibre/maplibre-native/issues/3396",
"ios": "https://github.com/maplibre/maplibre-native/issues/3396"
}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
}
},
"paint_color-relief": {
"color-relief-opacity": {
"type": "number",
"default": 1,
"minimum": 0,
"maximum": 1,
"doc": "The opacity at which the color-relief will be drawn.",
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "5.6.0",
"android": "https://github.com/maplibre/maplibre-native/issues/3408",
"ios": "https://github.com/maplibre/maplibre-native/issues/3408"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"color-relief-color": {
"type": "color",
"doc": "Defines the color of each pixel based on its elevation. Should be an expression that uses `[\"elevation\"]` as input.",
"example": [
"interpolate",
["linear"],
["elevation"],
0, "black",
8849, "white"
],
"transition": false,
"sdk-support": {
"basic functionality": {
"js": "5.6.0",
"android": "https://github.com/maplibre/maplibre-native/issues/3408",
"ios": "https://github.com/maplibre/maplibre-native/issues/3408"
},
"data-driven styling": {}
},
"expression": {
"interpolated": true,
"parameters": [
"elevation"
]
},
"property-type": "color-ramp"
}
},
"paint_background": {
"background-color": {
"type": "color",
"default": "#000000",
"doc": "The color with which the background will be drawn.",
"transition": true,
"requires": [
{
"!": "background-pattern"
}
],
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
},
"background-pattern": {
"type": "resolvedImage",
"transition": true,
"doc": "Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
},
"data-driven styling": {}
},
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"property-type": "cross-faded"
},
"background-opacity": {
"type": "number",
"default": 1,
"minimum": 0,
"maximum": 1,
"doc": "The opacity at which the background will be drawn.",
"transition": true,
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0"
}
},
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"property-type": "data-constant"
}
},
"transition": {
"duration": {
"type": "number",
"default": 300,
"minimum": 0,
"units": "milliseconds",
"doc": "Time allotted for transitions to complete."
},
"delay": {
"type": "number",
"default": 0,
"minimum": 0,
"units": "milliseconds",
"doc": "Length of time before a transition begins."
}
},
"property-type": {
"data-driven": {
"type": "property-type",
"doc": "Property is interpolable and can be represented using a property expression."
},
"cross-faded": {
"type": "property-type",
"doc": "Property is non-interpolable; rather, its values will be cross-faded to smoothly transition between integer zooms."
},
"cross-faded-data-driven": {
"type": "property-type",
"doc": "Property is non-interpolable; rather, its values will be cross-faded to smoothly transition between integer zooms. It can be represented using a property expression."
},
"color-ramp": {
"type": "property-type",
"doc": "Property should be specified using a color ramp from which the output color can be sampled based on a property calculation."
},
"data-constant": {
"type": "property-type",
"doc": "Property is interpolable but cannot be represented using a property expression."
},
"constant": {
"type": "property-type",
"doc": "Property is constant across all zoom levels and property values."
}
},
"promoteId": {
"*": {
"type": "string",
"doc": "A name of a feature property to use as ID for feature state."
}
}
}