ScatterGeo

public struct ScatterGeo<CoordinateData, LocationsData> : Trace, GeoSubplot where CoordinateData : Plotable, LocationsData : Plotable

The data visualized as scatter point or lines on a geographic map is provided either by longitude/latitude pairs in lon and lat respectively or by geographic location IDs or names in locations.

See also

Documentation for Python, JavaScript or R

  • Corresponding Plotly trace type.

    Declaration

    Swift

    public let type: String

  • Switch indicating whether the trace supports animation of its data.

    Declaration

    Swift

    public static var animatable: Bool { get }

  • Determines whether or not this trace is visible.

    If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

    Declaration

    Swift

    public var visible: Visible?

  • Determines whether or not an item corresponding to this trace is shown in the legend.

    Declaration

    Swift

    public var showLegend: Bool?

  • Sets the legend group for this trace.

    Traces part of the same legend group hide/show at the same time when toggling legend items.

    Declaration

    Swift

    public var legendGroup: String?

  • Sets the opacity of the trace.

    Declaration

    Swift

    public var opacity: Double?

  • Sets the trace name.

    The trace name appear as the legend item and on hover.

    Declaration

    Swift

    public var name: String?
  • uid

    Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

    Declaration

    Swift

    public var uid: String?
  • ids

    Assigns id labels to each datum.

    These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

    Declaration

    Swift

    public var ids: [String]?

  • Assigns extra data each datum.

    This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

    Declaration

    Swift

    public var customData: [String]?

  • Assigns extra meta information associated with this trace that can be used in various text attributes.

    Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

    Declaration

    Swift

    public var meta: Data<Anything>?

  • Array containing integer indices of selected points.

    Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

    Declaration

    Swift

    public var selectedPoints: Anything?

  • Undocumented

    Declaration

    Swift

    public var hoverLabel: HoverLabel?

  • Undocumented

    Declaration

    Swift

    public var stream: Stream?

  • Undocumented

    Declaration

    Swift

    public var transforms: [Transform]

  • Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title.

    Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

    Declaration

    Swift

    public var uiRevision: Anything?

  • Sets the longitude coordinates (in degrees East).

    Declaration

    Swift

    public var longitude: CoordinateData?

  • Sets the latitude coordinates (in degrees North).

    Declaration

    Swift

    public var latitude: CoordinateData?

  • Sets the coordinates via location IDs or names.

    Coordinates correspond to the centroid of each location given. See locationmode for more info.

    Declaration

    Swift

    public var locations: LocationsData?

  • Determines the set of locations used to match entries in locations to regions on the map.

    Values ISO-3, USA-states, country names correspond to features on the base map and value geojson-id corresponds to features from a custom GeoJSON linked to the geojson attribute.

    See more

    Declaration

    Swift

    public enum LocationMode : String, Encodable

  • Determines the set of locations used to match entries in locations to regions on the map.

    Values ISO-3, USA-states, country names correspond to features on the base map and value geojson-id corresponds to features from a custom GeoJSON linked to the geojson attribute.

    Declaration

    Swift

    public var locationMode: LocationMode?

  • Sets optional GeoJSON data associated with this trace.

    If not given, the features on the base map are used when locations is set. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type FeatureCollection or Feature with geometries of type Polygon or MultiPolygon.

    Declaration

    Swift

    public var geoJson: Anything?

  • Sets the key in GeoJSON features which is used as id to match the items included in the locations array.

    Only has an effect when geojson is set. Support nested property, for example properties.name.

    Declaration

    Swift

    public var featureIDKey: String?

  • Determines the drawing mode for this scatter trace.

    If the provided mode includes text then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is lines+markers. Otherwise, lines.

    Declaration

    Swift

    public var mode: Mode?

  • Sets text elements associated with each (lon,lat) pair or item in locations.

    If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) or locations coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

    Declaration

    Swift

    public var text: Data<String>?

  • Template string used for rendering the information text that appear on points.

    Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-format#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. variables lat, lon, location and text.

    Declaration

    Swift

    public var textTemplate: Data<String>?

  • Sets hover text elements associated with each (lon,lat) pair or item in locations.

    If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) or locations coordinates. To be seen, trace hoverinfo must contain a text flag.

    Declaration

    Swift

    public var hoverText: Data<String>?

  • Sets the text font.

    Declaration

    Swift

    public var textFont: VariableFont?

  • Sets the positions of the text elements with respects to the (x,y) coordinates.

    Declaration

    Swift

    public var textPosition: TextPosition?

  • Undocumented

    Declaration

    Swift

    public var line: DashedLine?

  • Determines whether or not gaps (i.e.

    {nan} or missing values) in the provided data arrays are connected.

    Declaration

    Swift

    public var connectGaps: Bool?

  • Undocumented

    See more

    Declaration

    Swift

    public struct GradientMarker : Encodable

  • Undocumented

    Declaration

    Swift

    public var marker: GradientMarker?

  • Sets the area to fill with a solid color.

    Use with fillcolor if not none. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

    See more

    Declaration

    Swift

    public enum Fill : String, Encodable

  • Sets the area to fill with a solid color.

    Use with fillcolor if not none. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

    Declaration

    Swift

    public var fill: Fill?

  • Sets the fill color.

    Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

    Declaration

    Swift

    public var fillColor: Color?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Selected : Encodable

  • Undocumented

    Declaration

    Swift

    public var selected: Selected?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Unselected : Encodable

  • Undocumented

    Declaration

    Swift

    public var unselected: Unselected?

  • Determines which trace information appear on hover.

    If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

    See more

    Declaration

    Swift

    public struct HoverInfo : OptionSet, Encodable

  • Determines which trace information appear on hover.

    If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

    Declaration

    Swift

    public var hoverInfo: HoverInfo?

  • Template string used for rendering the information that appear on hover box.

    Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-format#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example “{fullData.name}”. To hide the secondary box completely, use an empty tag <extra></extra>.

    Declaration

    Swift

    public var hoverTemplate: Data<String>?
  • geo

    Sets a reference between this trace’s geospatial coordinates and a geographic map.

    If geo (the default value), the geospatial coordinates refer to layout.geo. If geo2, the geospatial coordinates refer to layout.geo2, and so on.

    Declaration

    Swift

    public var geo: Geo

  • Creates ScatterGeo object from the most frequently used properties.

    Declaration

    Swift

    public init(name: String? = nil, longitude: CoordinateData? = nil, latitude: CoordinateData? =
        nil, locations: LocationsData? = nil, mode: Mode? = nil, text: Data<String>? = nil, hoverText:
        Data<String>? = nil, line: DashedLine? = nil, marker: GradientMarker? = nil)

    Parameters

    name

    Sets the trace name.
    longitude

    Sets the longitude coordinates (in degrees East).
    latitude

    Sets the latitude coordinates (in degrees North).
    locations

    Sets the coordinates via location IDs or names.
    mode

    Determines the drawing mode for this scatter trace.
    text

    Sets text elements associated with each (lon,lat) pair or item in locations.
    hoverText

    Sets hover text elements associated with each (lon,lat) pair or item in locations.
    line

    marker

  • Creates ScatterGeo object with specified properties.

    Declaration

    Swift

    public init(visible: Visible? = nil, showLegend: Bool? = nil, legendGroup: String? = nil,
        opacity: Double? = nil, name: String? = nil, uid: String? = nil, ids: [String]? = nil,
        customData: [String]? = nil, meta: Data<Anything>? = nil, selectedPoints: Anything? = nil,
        hoverLabel: HoverLabel? = nil, stream: Stream? = nil, transforms: [Transform] = [], uiRevision:
        Anything? = nil, longitude: CoordinateData? = nil, latitude: CoordinateData? = nil, locations:
        LocationsData? = nil, locationMode: LocationMode? = nil, geoJson: Anything? = nil, featureIDKey:
        String? = nil, mode: Mode? = nil, text: Data<String>? = nil, textTemplate: Data<String>? = nil,
        hoverText: Data<String>? = nil, textFont: VariableFont? = nil, textPosition: TextPosition? =
        nil, line: DashedLine? = nil, connectGaps: Bool? = nil, marker: GradientMarker? = nil, fill:
        Fill? = nil, fillColor: Color? = nil, selected: Selected? = nil, unselected: Unselected? = nil,
        hoverInfo: HoverInfo? = nil, hoverTemplate: Data<String>? = nil, geo: Geo = .preset)

    Parameters

    visible

    Determines whether or not this trace is visible.
    showLegend

    Determines whether or not an item corresponding to this trace is shown in the legend.
    legendGroup

    Sets the legend group for this trace.
    opacity

    Sets the opacity of the trace.
    name

    Sets the trace name.
    uid

    Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
    ids

    Assigns id labels to each datum.
    customData

    Assigns extra data each datum.
    meta

    Assigns extra meta information associated with this trace that can be used in various text attributes.
    selectedPoints

    Array containing integer indices of selected points.
    hoverLabel

    stream

    transforms

    uiRevision

    Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title.
    longitude

    Sets the longitude coordinates (in degrees East).
    latitude

    Sets the latitude coordinates (in degrees North).
    locations

    Sets the coordinates via location IDs or names.
    locationMode

    Determines the set of locations used to match entries in locations to regions on the map.
    geoJson

    Sets optional GeoJSON data associated with this trace.
    featureIDKey

    Sets the key in GeoJSON features which is used as id to match the items included in the locations array.
    mode

    Determines the drawing mode for this scatter trace.
    text

    Sets text elements associated with each (lon,lat) pair or item in locations.
    textTemplate

    Template string used for rendering the information text that appear on points.
    hoverText

    Sets hover text elements associated with each (lon,lat) pair or item in locations.
    textFont

    Sets the text font.
    textPosition

    Sets the positions of the text elements with respects to the (x,y) coordinates.
    line

    connectGaps

    Determines whether or not gaps (i.e.
    marker

    fill

    Sets the area to fill with a solid color.
    fillColor

    Sets the fill color.
    selected

    unselected

    hoverInfo

    Determines which trace information appear on hover.
    hoverTemplate

    Template string used for rendering the information that appear on hover box.
    geo

    Sets a reference between this trace’s geospatial coordinates and a geographic map.

  • Encodes the object in a format compatible with Plotly.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws