Geo

public final class Geo : Encodable, SubplotAxis

Undocumented

  • uid

    Unique identifier of the axis.

    Declaration

    Swift

    public var uid: UInt

  • Undocumented

    Declaration

    Swift

    public var domain: Domain?

  • Determines if this subplot’s view settings are auto-computed to fit trace data.

    On scoped maps, setting fitbounds leads to center.lon and center.lat getting auto-filled. On maps with a non-clipped projection, setting fitbounds leads to center.lon, center.lat, and projection.rotation.lon getting auto-filled. On maps with a clipped projection, setting fitbounds leads to center.lon, center.lat, projection.rotation.lon, projection.rotation.lat, lonaxis.range and lonaxis.range getting auto-filled. If locations, only the trace’s visible locations are considered in the fitbounds computations. If geojson, the entire trace input geojson (if provided) is considered in the fitbounds computations, Defaults to false.

    See more

    Declaration

    Swift

    public enum FitBounds : Encodable

  • Determines if this subplot’s view settings are auto-computed to fit trace data.

    On scoped maps, setting fitbounds leads to center.lon and center.lat getting auto-filled. On maps with a non-clipped projection, setting fitbounds leads to center.lon, center.lat, and projection.rotation.lon getting auto-filled. On maps with a clipped projection, setting fitbounds leads to center.lon, center.lat, projection.rotation.lon, projection.rotation.lat, lonaxis.range and lonaxis.range getting auto-filled. If locations, only the trace’s visible locations are considered in the fitbounds computations. If geojson, the entire trace input geojson (if provided) is considered in the fitbounds computations, Defaults to false.

    Declaration

    Swift

    public var fitBounds: FitBounds?

  • Sets the resolution of the base layers.

    The values have units of km/mm e.g. 110 corresponds to a scale ratio of 1:110,000,000.

    See more

    Declaration

    Swift

    public enum Resolution : Int, Encodable

  • Sets the resolution of the base layers.

    The values have units of km/mm e.g. 110 corresponds to a scale ratio of 1:110,000,000.

    Declaration

    Swift

    public var resolution: Resolution?

  • Set the scope of the map.

    See more

    Declaration

    Swift

    public enum Scope : String, Encodable

  • Set the scope of the map.

    Declaration

    Swift

    public var scope: Scope?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Projection : Encodable

  • Undocumented

    Declaration

    Swift

    public var projection: Projection?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Center : Encodable

  • Undocumented

    Declaration

    Swift

    public var center: Center?

  • Sets the default visibility of the base layers.

    Declaration

    Swift

    public var visible: Bool?

  • Sets whether or not the coastlines are drawn.

    Declaration

    Swift

    public var showCoastLines: Bool?

  • Sets the coastline color.

    Declaration

    Swift

    public var coastLineColor: Color?

  • Sets the coastline stroke width (in px).

    Declaration

    Swift

    public var coastLineWidth: Double?

  • Sets whether or not land masses are filled in color.

    Declaration

    Swift

    public var showLand: Bool?

  • Sets the land mass color.

    Declaration

    Swift

    public var landColor: Color?

  • Sets whether or not oceans are filled in color.

    Declaration

    Swift

    public var showOcean: Bool?

  • Sets the ocean color

    Declaration

    Swift

    public var oceanColor: Color?

  • Sets whether or not lakes are drawn.

    Declaration

    Swift

    public var showLakes: Bool?

  • Sets the color of the lakes.

    Declaration

    Swift

    public var lakeColor: Color?

  • Sets whether or not rivers are drawn.

    Declaration

    Swift

    public var showRivers: Bool?

  • Sets color of the rivers.

    Declaration

    Swift

    public var riverColor: Color?

  • Sets the stroke width (in px) of the rivers.

    Declaration

    Swift

    public var riverWidth: Double?

  • Sets whether or not country boundaries are drawn.

    Declaration

    Swift

    public var showCountries: Bool?

  • Sets line color of the country boundaries.

    Declaration

    Swift

    public var countryColor: Color?

  • Sets line width (in px) of the country boundaries.

    Declaration

    Swift

    public var countryWidth: Double?

  • Sets whether or not boundaries of subunits within countries (e.g.

    states, provinces) are drawn.

    Declaration

    Swift

    public var showSubunits: Bool?

  • Sets the color of the subunits boundaries.

    Declaration

    Swift

    public var subUnitColor: Color?

  • Sets the stroke width (in px) of the subunits boundaries.

    Declaration

    Swift

    public var subUnitWidth: Double?

  • Sets whether or not a frame is drawn around the map.

    Declaration

    Swift

    public var showFrame: Bool?

  • Sets the color the frame.

    Declaration

    Swift

    public var frameColor: Color?

  • Sets the stroke width (in px) of the frame.

    Declaration

    Swift

    public var frameWidth: Double?

  • Set the background color of the map

    Declaration

    Swift

    public var backgroundColor: Color?

  • Undocumented

    See more

    Declaration

    Swift

    public struct LongitudeAxis : Encodable

  • Undocumented

    Declaration

    Swift

    public var longitudeAxis: LongitudeAxis?

  • Undocumented

    See more

    Declaration

    Swift

    public struct LatitudeAxis : Encodable

  • Undocumented

    Declaration

    Swift

    public var latitudeAxis: LatitudeAxis?

  • Controls persistence of user-driven changes in the view (projection and center).

    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: Geo

  • Creates Geo object with specified properties.

    Declaration

    Swift

    public init(uid: UInt = UInt.random(in: 2...UInt.max), domain: Domain? = nil, fitBounds:
        FitBounds? = nil, resolution: Resolution? = nil, scope: Scope? = nil, projection: Projection? =
        nil, center: Center? = nil, visible: Bool? = nil, showCoastLines: Bool? = nil, coastLineColor:
        Color? = nil, coastLineWidth: Double? = nil, showLand: Bool? = nil, landColor: Color? = nil,
        showOcean: Bool? = nil, oceanColor: Color? = nil, showLakes: Bool? = nil, lakeColor: Color? =
        nil, showRivers: Bool? = nil, riverColor: Color? = nil, riverWidth: Double? = nil,
        showCountries: Bool? = nil, countryColor: Color? = nil, countryWidth: Double? = nil,
        showSubunits: Bool? = nil, subUnitColor: Color? = nil, subUnitWidth: Double? = nil, showFrame:
        Bool? = nil, frameColor: Color? = nil, frameWidth: Double? = nil, backgroundColor: Color? = nil,
        longitudeAxis: LongitudeAxis? = nil, latitudeAxis: LatitudeAxis? = nil, uiRevision: Anything? =
        nil)

    Parameters

    uid

    Unique identifier of the axis.
    domain

    fitBounds

    Determines if this subplot’s view settings are auto-computed to fit trace data.
    resolution

    Sets the resolution of the base layers.
    scope

    Set the scope of the map.
    projection

    center

    visible

    Sets the default visibility of the base layers.
    showCoastLines

    Sets whether or not the coastlines are drawn.
    coastLineColor

    Sets the coastline color.
    coastLineWidth

    Sets the coastline stroke width (in px).
    showLand

    Sets whether or not land masses are filled in color.
    landColor

    Sets the land mass color.
    showOcean

    Sets whether or not oceans are filled in color.
    oceanColor

    Sets the ocean color
    showLakes

    Sets whether or not lakes are drawn.
    lakeColor

    Sets the color of the lakes.
    showRivers

    Sets whether or not rivers are drawn.
    riverColor

    Sets color of the rivers.
    riverWidth

    Sets the stroke width (in px) of the rivers.
    showCountries

    Sets whether or not country boundaries are drawn.
    countryColor

    Sets line color of the country boundaries.
    countryWidth

    Sets line width (in px) of the country boundaries.
    showSubunits

    Sets whether or not boundaries of subunits within countries (e.g.
    subUnitColor

    Sets the color of the subunits boundaries.
    subUnitWidth

    Sets the stroke width (in px) of the subunits boundaries.
    showFrame

    Sets whether or not a frame is drawn around the map.
    frameColor

    Sets the color the frame.
    frameWidth

    Sets the stroke width (in px) of the frame.
    backgroundColor

    Set the background color of the map
    longitudeAxis

    latitudeAxis

    uiRevision

    Controls persistence of user-driven changes in the view (projection and center).