DensityMapbox Structure Reference


                    
                    
                    type

Corresponding Plotly trace type.

Declaration

Swift

public let type: String


                    
                    
                    animatable

Switch indicating whether the trace supports animation of its data.

Declaration

Swift

public static var animatable: Bool { get }


                    
                    
                    visible

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?


                    
                    
                    legendGroup

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?


                    
                    
                    opacity

Sets the opacity of the trace.

Declaration

Swift

public var opacity: Double?


                    
                    
                    name

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]?


                    
                    
                    customData

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]?


                    
                    
                    meta

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


                    
                    
                    hoverLabel

Undocumented

Declaration

Swift

public var hoverLabel: HoverLabel?


                    
                    
                    stream

Undocumented

Declaration

Swift

public var stream: Stream?


                    
                    
                    transforms

Undocumented

Declaration

Swift

public var transforms: [Transform]


                    
                    
                    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.

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?


                    
                    
                    longitude

Sets the longitude coordinates (in degrees East).

Declaration

Swift

public var longitude: CoordinateData?


                    
                    
                    latitude

Sets the latitude coordinates (in degrees North).

Declaration

Swift

public var latitude: CoordinateData?

Sets the points’ weight.

For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot

Declaration

Swift

public var z: ZData?


                    
                    
                    radius

Sets the radius of influence of one lon / lat point in pixels.

Increasing the value makes the densitymapbox trace smoother, but less detailed.

Declaration

Swift

public var radius: Data<Double>?


                    
                    
                    below

Determines if the densitymapbox trace will be inserted before the layer with the specified ID.

By default, densitymapbox traces are placed below the first layer of type symbol If set to “, the layer will be inserted above every existing layer.

Declaration

Swift

public var below: String?


                    
                    
                    text

Sets text elements associated with each (lon,lat) pair 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) 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>?


                    
                    
                    hoverText

Sets hover text elements associated with each (lon,lat) pair 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) coordinates. To be seen, trace hoverinfo must contain a text flag.

Declaration

Swift

public var hoverText: Data<String>?


                    
                    
                    HoverInfo

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 struct HoverInfo : OptionSet, Encodable


                    
                    
                    hoverInfo

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?


                    
                    
                    hoverTemplate

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


                    
                    
                    showLegend

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

Declaration

Swift

public var showLegend: Bool?


                    
                    
                    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.

Declaration

Swift

public var zAuto: Bool?


                    
                    
                    zMin

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?


                    
                    
                    zMax

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?


                    
                    
                    zMiddle

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?


                    
                    
                    colorScale

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?


                    
                    
                    autoColorScale

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?


                    
                    
                    reverseScale

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?


                    
                    
                    showScale

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

Declaration

Swift

public var showScale: Bool?


                    
                    
                    colorBar

Undocumented

Declaration

Swift

public var colorBar: ColorBar?


                    
                    
                    colorAxis

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


                    
                    
                    subplot

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


                    
                    
                    init(name:longitude:latitude:z:text:hoverText:colorScale:reverseScale:)

Creates DensityMapbox object from the most frequently used properties.

Declaration

Swift

public init(name: String? = nil, longitude: CoordinateData? = nil, latitude: CoordinateData? =
        nil, z: ZData? = nil, text: Data<String>? = nil, hoverText: Data<String>? = nil, colorScale:
        ColorScale? = nil, reverseScale: Bool? = nil)

Parameters

`name`	Sets the trace name.
`longitude`	Sets the longitude coordinates (in degrees East).
`latitude`	Sets the latitude coordinates (in degrees North).
`z`	Sets the points’ weight.
`text`	Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points.
`hoverText`	Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points.
`colorScale`	Sets the colorscale.
`reverseScale`	Reverses the color mapping if true.


                    
                    
                    init(visible:legendGroup:opacity:name:uid:ids:customData:meta:hoverLabel:stream:transforms:uiRevision:longitude:latitude:z:radius:below:text:hoverText:hoverInfo:hoverTemplate:showLegend:zAuto:zMin:zMax:zMiddle:colorScale:autoColorScale:reverseScale:showScale:colorBar:colorAxis:subplot:)

Creates DensityMapbox object with specified properties.

Declaration

Swift

public init(visible: Visible? = nil, legendGroup: String? = nil, opacity: Double? = nil, name:
        String? = nil, uid: String? = nil, ids: [String]? = nil, customData: [String]? = nil, meta:
        Data<Anything>? = nil, hoverLabel: HoverLabel? = nil, stream: Stream? = nil, transforms:
        [Transform] = [], uiRevision: Anything? = nil, longitude: CoordinateData? = nil, latitude:
        CoordinateData? = nil, z: ZData? = nil, radius: Data<Double>? = nil, below: String? = nil, text:
        Data<String>? = nil, hoverText: Data<String>? = 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.
`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.
`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).
`z`	Sets the points’ weight.
`radius`	Sets the radius of influence of one `lon` / `lat` point in pixels.
`below`	Determines if the densitymapbox trace will be inserted before the layer with the specified ID.
`text`	Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points.
`hoverText`	Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points.
`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.


                    
                    
                    encode(to:)

Encodes the object in a format compatible with Plotly.

Declaration

Swift

public func encode(to encoder: Encoder) throws