## Mapbox Type

Determines the style of the map shown in mapbox traces

### Constructors

 Constructor Description  Mapbox()  Full Usage: Mapbox() Returns: Mapbox Returns: Mapbox

### Static members

 Static member Description  Mapbox.init (?Domain, ?AccessToken, ?Style, ?Center, ?Zoom, ?Bearing, ?Pitch, ?Layers)  Full Usage: Mapbox.init (?Domain, ?AccessToken, ?Style, ?Center, ?Zoom, ?Bearing, ?Pitch, ?Layers) Parameters: ?Domain : Domain - Sets the domain of the Mapbox subplot ?AccessToken : string - Sets the mapbox access token to be used for this mapbox map. Alternatively, the mapbox access token can be set in the configuration options under mapboxAccessToken. Note that accessToken are only required when style (e.g with values : basic, streets, outdoors, light, dark, satellite, satellite-streets ) and/or a layout layer references the Mapbox server. ?Style : MapboxStyle - 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: carto-darkmatter, carto-positron, open-street-map, stamen-terrain, stamen-toner, stamen-watercolor, white-bg The built-in Mapbox styles are: basic, streets, outdoors, light, dark, satellite, satellite-streets Mapbox style URLs are of the form: mapbox://mapbox.mapbox/name/version ?Center : float * float - Sets the (lon,lat) coordinates of the center of the map view ?Zoom : float - Sets the zoom level of the map (mapbox.zoom). ?Bearing : float - Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing). ?Pitch : float - Sets the pitch angle of the map (in degrees, where "0" means perpendicular to the surface of the map) (mapbox.pitch). ?Layers : seq - Sets the layers of this Mapbox Returns: Mapbox Returns a new Mapbox object with the given styles applied. ?Domain : Domain Sets the domain of the Mapbox subplot ?AccessToken : string Sets the mapbox access token to be used for this mapbox map. Alternatively, the mapbox access token can be set in the configuration options under mapboxAccessToken. Note that accessToken are only required when style (e.g with values : basic, streets, outdoors, light, dark, satellite, satellite-streets ) and/or a layout layer references the Mapbox server. ?Style : MapboxStyle 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: carto-darkmatter, carto-positron, open-street-map, stamen-terrain, stamen-toner, stamen-watercolor, white-bg The built-in Mapbox styles are: basic, streets, outdoors, light, dark, satellite, satellite-streets Mapbox style URLs are of the form: mapbox://mapbox.mapbox/name/version ?Center : float * float Sets the (lon,lat) coordinates of the center of the map view ?Zoom : float Sets the zoom level of the map (mapbox.zoom). ?Bearing : float Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing). ?Pitch : float Sets the pitch angle of the map (in degrees, where "0" means perpendicular to the surface of the map) (mapbox.pitch). ?Layers : seq Sets the layers of this Mapbox Returns: Mapbox  Mapbox.style (?Domain, ?AccessToken, ?Style, ?Center, ?Zoom, ?Bearing, ?Pitch, ?Layers)  Full Usage: Mapbox.style (?Domain, ?AccessToken, ?Style, ?Center, ?Zoom, ?Bearing, ?Pitch, ?Layers) Parameters: ?Domain : Domain - Sets the domain of the Mapbox subplot ?AccessToken : string - Sets the mapbox access token to be used for this mapbox map. Alternatively, the mapbox access token can be set in the configuration options under mapboxAccessToken. Note that accessToken are only required when style (e.g with values : basic, streets, outdoors, light, dark, satellite, satellite-streets ) and/or a layout layer references the Mapbox server. ?Style : MapboxStyle - 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: carto-darkmatter, carto-positron, open-street-map, stamen-terrain, stamen-toner, stamen-watercolor, white-bg The built-in Mapbox styles are: basic, streets, outdoors, light, dark, satellite, satellite-streets Mapbox style URLs are of the form: mapbox://mapbox.mapbox/name/version ?Center : float * float - Sets the (lon,lat) coordinates of the center of the map view ?Zoom : float - Sets the zoom level of the map (mapbox.zoom). ?Bearing : float - Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing). ?Pitch : float - Sets the pitch angle of the map (in degrees, where "0" means perpendicular to the surface of the map) (mapbox.pitch). ?Layers : seq - Sets the layers of this Mapbox Returns: Mapbox -> Mapbox Create a function that applies the given style parameters to a Mapbox object. ?Domain : Domain Sets the domain of the Mapbox subplot ?AccessToken : string Sets the mapbox access token to be used for this mapbox map. Alternatively, the mapbox access token can be set in the configuration options under mapboxAccessToken. Note that accessToken are only required when style (e.g with values : basic, streets, outdoors, light, dark, satellite, satellite-streets ) and/or a layout layer references the Mapbox server. ?Style : MapboxStyle 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: carto-darkmatter, carto-positron, open-street-map, stamen-terrain, stamen-toner, stamen-watercolor, white-bg The built-in Mapbox styles are: basic, streets, outdoors, light, dark, satellite, satellite-streets Mapbox style URLs are of the form: mapbox://mapbox.mapbox/name/version ?Center : float * float Sets the (lon,lat) coordinates of the center of the map view ?Zoom : float Sets the zoom level of the map (mapbox.zoom). ?Bearing : float Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing). ?Pitch : float Sets the pitch angle of the map (in degrees, where "0" means perpendicular to the surface of the map) (mapbox.pitch). ?Layers : seq Sets the layers of this Mapbox Returns: Mapbox -> Mapbox