@maplibre/maplibre-gl-style-spec

{ "$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.<h2>Unicode range</h2>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\n<h2>Font Resolution</h2>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\n<h2>Supported Fonts</h2>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 `{<sourceLayer>: <propertyName>}`. 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" } } }, "encoding": { "type": "enum", "values": { "mvt": { "doc": "Mapbox Vector Tiles. See http://github.com/mapbox/vector-tile-spec for more info." }, "mlt": { "doc": "MapLibre Vector Tiles. See https://github.com/maplibre/maplibre-tile-spec for more info." } }, "default": "mvt", "doc": "The encoding used by this source. Mapbox Vector Tiles encoding is used by default.", "sdk-support": { "mvt": { "android": "supported", "ios": "supported", "js": "supported" }, "mlt": { "android": "https://github.com/maplibre/maplibre-native/issues/3721", "ios": "https://github.com/maplibre/maplibre-native/issues/3721", "js": "https://github.com/maplibre/maplibre-gl-js/issues/6258" } } }, "*": { "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 `{<sourceLayer>: <propertyName>}`." } }, "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",