Mapbox

public final class Mapbox : Encodable, SubplotAxis

Undocumented

  • uid

    Unique identifier of the axis.

    Declaration

    Swift

    public var uid: UInt

  • Undocumented

    Declaration

    Swift

    public var domain: Domain?

  • 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.

    Declaration

    Swift

    public var accessToken: String?

  • 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--

    Declaration

    Swift

    public var style: Anything?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Center : Encodable

  • Undocumented

    Declaration

    Swift

    public var center: Center?

  • Sets the zoom level of the map (mapbox.zoom).

    Declaration

    Swift

    public var zoom: Double?

  • Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing).

    Declaration

    Swift

    public var bearing: Double?

  • Sets the pitch angle of the map (in degrees, where 0 means perpendicular to the surface of the map) (mapbox.pitch).

    Declaration

    Swift

    public var pitch: Double?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Layer : Encodable

  • Undocumented

    Declaration

    Swift

    public var layers: [Layer]?

  • Controls persistence of user-driven changes in the view: center, zoom, bearing, pitch.

    Defaults to layout.uirevision.

    Declaration

    Swift

    public var uiRevision: Anything?

  • Shared and preset default axis reference used to initialize layout and all traces.

    Declaration

    Swift

    public static let preset: Mapbox

  • Creates Mapbox object with specified properties.

    Declaration

    Swift

    public init(uid: UInt = UInt.random(in: 2...UInt.max), domain: Domain? = nil, accessToken:
        String? = nil, style: Anything? = nil, center: Center? = nil, zoom: Double? = nil, bearing:
        Double? = nil, pitch: Double? = nil, layers: [Layer]? = nil, uiRevision: Anything? = nil)

    Parameters

    uid

    Unique identifier of the axis.
    domain

    accessToken

    Sets the mapbox access token to be used for this mapbox map.
    style

    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.
    center

    zoom

    Sets the zoom level of the map (mapbox.zoom).
    bearing

    Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing).
    pitch

    Sets the pitch angle of the map (in degrees, where 0 means perpendicular to the surface of the map) (mapbox.pitch).
    layers

    uiRevision

    Controls persistence of user-driven changes in the view: center, zoom, bearing, pitch.