ScatterPlotMatrix

public struct ScatterPlotMatrix : Trace

Splom traces generate scatter plot matrix visualizations.

Each splom dimensions items correspond to a generated axis. Values for each of those dimensions are set in dimensions[i].values. Splom traces support all scattergl marker style attributes. Specify layout.grid attributes and/or layout x-axis and y-axis attributes for more control over the axis positioning and style.

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

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

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

  • Undocumented

    See more

    Declaration

    Swift

    public struct Dimension : Encodable

  • Undocumented

    Declaration

    Swift

    public var dimensions: [Dimension]?

  • Sets text elements associated with each (x,y) pair to appear on hover.

    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 (x,y) coordinates.

    Declaration

    Swift

    public var text: Data<String>?

  • Same as text.

    Declaration

    Swift

    public var hoverText: Data<String>?

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

  • Undocumented

    Declaration

    Swift

    public var marker: SymbolicMarker?

  • Sets the list of x axes corresponding to dimensions of this splom trace.

    By default, a splom will match the first N xaxes where N is the number of input dimensions. Note that, in case where diagonal.visible is false and showupperhalf or showlowerhalf is false, this splom trace will generate one less x-axis and one less y-axis.

    Declaration

    Swift

    public var xAxes: InfoArray?

  • Sets the list of y axes corresponding to dimensions of this splom trace.

    By default, a splom will match the first N yaxes where N is the number of input dimensions. Note that, in case where diagonal.visible is false and showupperhalf or showlowerhalf is false, this splom trace will generate one less x-axis and one less y-axis.

    Declaration

    Swift

    public var yAxes: InfoArray?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Diagonal : Encodable

  • Undocumented

    Declaration

    Swift

    public var diagonal: Diagonal?

  • Determines whether or not subplots on the upper half from the diagonal are displayed.

    Declaration

    Swift

    public var showUpperHalf: Bool?

  • Determines whether or not subplots on the lower half from the diagonal are displayed.

    Declaration

    Swift

    public var showLowerHalf: Bool?

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

  • Sets the opacity of the trace.

    Declaration

    Swift

    public var opacity: Double?

  • Creates ScatterPlotMatrix object from the most frequently used properties.

    Declaration

    Swift

    public init(name: String? = nil, text: Data<String>? = nil, hoverText: Data<String>? = nil,
        marker: SymbolicMarker? = nil)

    Parameters

    name

    Sets the trace name.
    text

    Sets text elements associated with each (x,y) pair to appear on hover.
    hoverText

    Same as text.
    marker

  • Creates ScatterPlotMatrix object with specified properties.

    Declaration

    Swift

    public init(visible: Visible? = nil, showLegend: Bool? = nil, legendGroup: String? = nil, name:
        String? = nil, uid: String? = nil, ids: [String]? = nil, customData: [String]? = nil, meta:
        Data<Anything>? = nil, selectedPoints: Anything? = nil, hoverInfo: HoverInfo? = nil, hoverLabel:
        HoverLabel? = nil, stream: Stream? = nil, transforms: [Transform] = [], uiRevision: Anything? =
        nil, dimensions: [Dimension]? = nil, text: Data<String>? = nil, hoverText: Data<String>? = nil,
        hoverTemplate: Data<String>? = nil, marker: SymbolicMarker? = nil, xAxes: InfoArray? = nil,
        yAxes: InfoArray? = nil, diagonal: Diagonal? = nil, showUpperHalf: Bool? = nil, showLowerHalf:
        Bool? = nil, selected: Selected? = nil, unselected: Unselected? = nil, opacity: Double? = nil)

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

    Determines which trace information appear on hover.
    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.
    dimensions

    text

    Sets text elements associated with each (x,y) pair to appear on hover.
    hoverText

    Same as text.
    hoverTemplate

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

    xAxes

    Sets the list of x axes corresponding to dimensions of this splom trace.
    yAxes

    Sets the list of y axes corresponding to dimensions of this splom trace.
    diagonal

    showUpperHalf

    Determines whether or not subplots on the upper half from the diagonal are displayed.
    showLowerHalf

    Determines whether or not subplots on the lower half from the diagonal are displayed.
    selected

    unselected

    opacity

    Sets the opacity of the trace.

  • Encodes the object in a format compatible with Plotly.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws