MapboxStyle Type
Defines the map layers that are rendered by default below the trace layers defined in `data`, which are themselves by default rendered below the layers defined in `layout.mapbox.layers`.
These layers can be defined either explicitly as a Mapbox Style object which can contain multiple layer definitions that load data from any public or private Tile Map Service (TMS or XYZ) or Web Map Service (WMS) or implicitly by using one of the built-in style objects which use WMSes which do not require any access tokens,
or by using a default Mapbox style or custom Mapbox style URL, both of which require a Mapbox access token Note that Mapbox access token can be set in the `accesstoken` attribute or in the `mapboxAccessToken` config option.
Mapbox Style objects are of the form described in the Mapbox GL JS documentation available at https://docs.mapbox.com/mapbox-gl-js/style-spec The built-in plotly.js styles objects are: open-street-map, white-bg, carto-positron, carto-darkmatter, stamen-terrain, stamen-toner, stamen-watercolor
The built-in Mapbox styles are: basic, streets, outdoors, light, dark, satellite, satellite-streets Mapbox style URLs are of the form: mapbox://mapbox.mapbox-
Union cases
Union case | Description |
Full Usage:
CartoDarkmatter
|
|
Full Usage:
CartoPositron
|
|
Full Usage:
Custom string
Parameters:
string
|
|
Full Usage:
MapboxBasic
|
|
Full Usage:
MapboxDark
|
|
Full Usage:
MapboxLight
|
|
Full Usage:
MapboxOutdoors
|
|
Full Usage:
MapboxSatellite
|
|
Full Usage:
MapboxSatelliteStreets
|
|
Full Usage:
MapboxStreets
|
|
Full Usage:
OpenStreetMap
|
|
Full Usage:
StamenTerrain
|
|
Full Usage:
StamenToner
|
|
Full Usage:
StamenWatercolor
|
|
Full Usage:
WhiteBG
|
Instance members
Instance member | Description |
Full Usage:
this.Convert
Returns: obj
|
|
Static members
Static member | Description |
|
|
|
|