ChoroplethMapbox

public struct ChoroplethMapbox<LocationsData, ZData> : Trace, MapboxSubplot where LocationsData : Plotable, ZData : Plotable

GeoJSON features to be filled are set in geojson The data that describes the choropleth value-to-color mapping is set in locations and z.

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?

  • 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 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 which features found in geojson to plot using their feature id field.

    Declaration

    Swift

    public var locations: LocationsData?
  • z

    Sets the color values.

    Declaration

    Swift

    public var z: ZData?

  • Sets the GeoJSON data associated with this trace.

    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.

    Support nested property, for example properties.name.

    Declaration

    Swift

    public var featureIDKey: String?

  • Determines if the choropleth polygons will be inserted before the layer with the specified ID.

    By default, choroplethmapbox traces are placed above the water layers. If set to “, the layer will be inserted above every existing layer.

    Declaration

    Swift

    public var below: String?

  • Sets the text elements associated with each location.

    Declaration

    Swift

    public var text: Data<String>?

  • Same as text.

    Declaration

    Swift

    public var hoverText: Data<String>?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Marker : Encodable

  • Undocumented

    Declaration

    Swift

    public var marker: Marker?

  • 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. variable properties 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>?

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

    Declaration

    Swift

    public var showLegend: Bool?

  • Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

    Declaration

    Swift

    public var zAuto: Bool?

  • Sets the lower bound of the color domain.

    Value should have the same units as in z and if set, zmax must be set as well.

    Declaration

    Swift

    public var zMin: Double?

  • Sets the upper bound of the color domain.

    Value should have the same units as in z and if set, zmin must be set as well.

    Declaration

    Swift

    public var zMax: Double?

  • Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point.

    Value should have the same units as in z. Has no effect when zauto is false.

    Declaration

    Swift

    public var zMiddle: Double?

  • Sets the colorscale.

    The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, usezmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

    Declaration

    Swift

    public var colorScale: ColorScale?

  • Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale.

    In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

    Declaration

    Swift

    public var autoColorScale: Bool?

  • Reverses the color mapping if true.

    If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

    Declaration

    Swift

    public var reverseScale: Bool?

  • Determines whether or not a colorbar is displayed for this trace.

    Declaration

    Swift

    public var showScale: Bool?

  • Undocumented

    Declaration

    Swift

    public var colorBar: ColorBar?

  • Sets a reference to a shared color axis.

    References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

    Declaration

    Swift

    public var colorAxis: ColorAxis

  • Sets a reference between this trace’s data coordinates and a mapbox subplot.

    If mapbox (the default value), the data refer to layout.mapbox. If mapbox2, the data refer to layout.mapbox2, and so on.

    Declaration

    Swift

    public var subplot: Mapbox

  • Creates ChoroplethMapbox object from the most frequently used properties.

    Declaration

    Swift

    public init(name: String? = nil, locations: LocationsData? = nil, z: ZData? = nil, text:
        Data<String>? = nil, hoverText: Data<String>? = nil, marker: Marker? = nil, colorScale:
        ColorScale? = nil, reverseScale: Bool? = nil)

    Parameters

    name

    Sets the trace name.
    locations

    Sets which features found in geojson to plot using their feature id field.
    z

    Sets the color values.
    text

    Sets the text elements associated with each location.
    hoverText

    Same as text.
    marker

    colorScale

    Sets the colorscale.
    reverseScale

    Reverses the color mapping if true.

  • Creates ChoroplethMapbox object with specified properties.

    Declaration

    Swift

    public init(visible: Visible? = nil, legendGroup: String? = 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, locations: LocationsData? = nil, z:
        ZData? = nil, geoJson: Anything? = nil, featureIDKey: String? = nil, below: String? = nil, text:
        Data<String>? = nil, hoverText: Data<String>? = nil, marker: Marker? = nil, selected: Selected?
        = nil, unselected: Unselected? = nil, hoverInfo: HoverInfo? = nil, hoverTemplate: Data<String>?
        = nil, showLegend: Bool? = nil, zAuto: Bool? = nil, zMin: Double? = nil, zMax: Double? = nil,
        zMiddle: Double? = nil, colorScale: ColorScale? = nil, autoColorScale: Bool? = nil,
        reverseScale: Bool? = nil, showScale: Bool? = nil, colorBar: ColorBar? = nil, colorAxis:
        ColorAxis = .preset, subplot: Mapbox = .preset)

    Parameters

    visible

    Determines whether or not this trace is visible.
    legendGroup

    Sets the legend group for this 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.
    locations

    Sets which features found in geojson to plot using their feature id field.
    z

    Sets the color values.
    geoJson

    Sets the 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.
    below

    Determines if the choropleth polygons will be inserted before the layer with the specified ID.
    text

    Sets the text elements associated with each location.
    hoverText

    Same as text.
    marker

    selected

    unselected

    hoverInfo

    Determines which trace information appear on hover.
    hoverTemplate

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

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

    Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.
    zMin

    Sets the lower bound of the color domain.
    zMax

    Sets the upper bound of the color domain.
    zMiddle

    Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point.
    colorScale

    Sets the colorscale.
    autoColorScale

    Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale.
    reverseScale

    Reverses the color mapping if true.
    showScale

    Determines whether or not a colorbar is displayed for this trace.
    colorBar

    colorAxis

    Sets a reference to a shared color axis.
    subplot

    Sets a reference between this trace’s data coordinates and a mapbox subplot.

  • Encodes the object in a format compatible with Plotly.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws