Mapbox
- Last UpdatedFeb 27, 2025
- 2 minute read
Adds a layer defined using Mapbox Style Specification. Some of the GIS Servers that supports these specifications are:
-
Mapbox
-
Maptiler
-
Esri (basemap layers)
An API key is required to use Mapbox services. For more information about obtaining an API key, see the Mapbox website- https://docs.mapbox.com/api/overview/.
The following table provides the specific configurable options available for this layer.
|
Property |
Type |
Description |
|---|---|---|
|
token [Optional] |
String |
Provides access token to use when retrieving the layer information (if needed). |
|
tokenParam [Optional] |
String |
Provides the name of the query parameter to use when sending the access token.
|
|
type |
mapbox |
A type of Layer. |
|
url |
String |
Provides the address of the Mapbox style definition. |
Examples for Mapbox
Below are two examples of layers using the Mapbox style specification:
Mapbox dark style
-
Configuration and map preview
-
JSON string configuration
{
"title": "Mapbox dark",
"type": "mapbox",
"url": "https://api.mapbox.com/styles/v/mapbox/dark-v/?access_token={ACCESS_TOKEN}",
"isBaseMap": true
}
Esri night style
-
Configuration and map preview
-
JSON string configuration
{
"title": "Esri night style",
"type": "mapbox",
"url": "https://www.arcgis.com/sharing/rest/content/items/faaaaafcbb/resources/styles/root.json?f=json",
"isBaseMap": true
}