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

CartoDarkmatter

Full Usage: CartoDarkmatter

CartoPositron

Full Usage: CartoPositron

Custom string

Full Usage: Custom string

Parameters:
    Item : string

Item : string

MapboxBasic

Full Usage: MapboxBasic

MapboxDark

Full Usage: MapboxDark

MapboxLight

Full Usage: MapboxLight

MapboxOutdoors

Full Usage: MapboxOutdoors

MapboxSatellite

Full Usage: MapboxSatellite

MapboxSatelliteStreets

Full Usage: MapboxSatelliteStreets

MapboxStreets

Full Usage: MapboxStreets

OpenStreetMap

Full Usage: OpenStreetMap

StamenTerrain

Full Usage: StamenTerrain

StamenToner

Full Usage: StamenToner

StamenWatercolor

Full Usage: StamenWatercolor

WhiteBG

Full Usage: WhiteBG

Instance members

Instance member Description

this.Convert

Full Usage: this.Convert

Returns: obj
Returns: obj

Static members

Static member Description

MapboxStyle.convert

Full Usage: MapboxStyle.convert

Returns: MapboxStyle -> obj
Returns: MapboxStyle -> obj

MapboxStyle.toString

Full Usage: MapboxStyle.toString

Returns: MapboxStyle -> string
Returns: MapboxStyle -> string