Scatter3D

public struct Scatter3D<XData, YData, ZData> : Trace, SceneSubplot where XData : Plotable, YData : Plotable, ZData : Plotable

The data visualized as scatter point or lines in 3D dimension is set in x, y, z.

Text (appearing either on the chart or on hover only) is via text. Bubble charts are achieved by setting marker.size and/or marker.color Projections are achieved via projection. Surface fills are achieved via surfaceaxis.

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

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

    Sets the x coordinates.

    Declaration

    Swift

    public var x: XData?
  • y

    Sets the y coordinates.

    Declaration

    Swift

    public var y: YData?
  • z

    Sets the z coordinates.

    Declaration

    Swift

    public var z: ZData?

  • Sets text elements associated with each (x,y,z) triplet.

    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,z) 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.

    Declaration

    Swift

    public var textTemplate: Data<String>?

  • Sets text elements associated with each (x,y,z) triplet.

    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,z) coordinates. To be seen, trace hoverinfo must contain a text flag.

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

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

  • If -1, the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a Delaunay surface about the x, y, z respectively.

    See more

    Declaration

    Swift

    public enum SurfaceAxis : Int, Encodable

  • If -1, the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a Delaunay surface about the x, y, z respectively.

    Declaration

    Swift

    public var surfaceAxis: SurfaceAxis?

  • Sets the surface fill color.

    Declaration

    Swift

    public var surfaceColor: Color?

  • Undocumented

    Declaration

    Swift

    public var projection: Projection?

  • 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 DashedMarkerLine : Encodable

  • Undocumented

    Declaration

    Swift

    public var line: DashedMarkerLine?

  • Undocumented

    Declaration

    Swift

    public var marker: SymbolicMarker?

  • 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 textFont: VariableFont?

  • 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 xError: Error?

  • Undocumented

    Declaration

    Swift

    public var yError: Error?

  • Undocumented

    Declaration

    Swift

    public var zError: Error?

  • Sets the calendar system to use with x date data.

    Declaration

    Swift

    public var xCalendar: Calendar?

  • Sets the calendar system to use with y date data.

    Declaration

    Swift

    public var yCalendar: Calendar?

  • Sets the calendar system to use with z date data.

    Declaration

    Swift

    public var zCalendar: Calendar?

  • Sets a reference between this trace’s 3D coordinate system and a 3D scene.

    If scene (the default value), the (x,y,z) coordinates refer to layout.scene. If scene2, the (x,y,z) coordinates refer to layout.scene2, and so on.

    Declaration

    Swift

    public var scene: Scene

  • Creates Scatter3D object from the most frequently used properties.

    Declaration

    Swift

    public init(name: String? = nil, x: XData? = nil, y: YData? = nil, z: ZData? = nil, text:
        Data<String>? = nil, hoverText: Data<String>? = nil, mode: Mode? = nil, line: DashedMarkerLine?
        = nil, marker: SymbolicMarker? = nil)

    Parameters

    name

    Sets the trace name.
    x

    Sets the x coordinates.
    y

    Sets the y coordinates.
    z

    Sets the z coordinates.
    text

    Sets text elements associated with each (x,y,z) triplet.
    hoverText

    Sets text elements associated with each (x,y,z) triplet.
    mode

    Determines the drawing mode for this scatter trace.
    line

    marker

  • Creates Scatter3D 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, hoverLabel: HoverLabel? = nil, stream:
        Stream? = nil, transforms: [Transform] = [], uiRevision: Anything? = nil, x: XData? = nil, y:
        YData? = nil, z: ZData? = nil, text: Data<String>? = nil, textTemplate: Data<String>? = nil,
        hoverText: Data<String>? = nil, hoverTemplate: Data<String>? = nil, mode: Mode? = nil,
        surfaceAxis: SurfaceAxis? = nil, surfaceColor: Color? = nil, projection: Projection? = nil,
        connectGaps: Bool? = nil, line: DashedMarkerLine? = nil, marker: SymbolicMarker? = nil,
        textPosition: TextPosition? = nil, textFont: VariableFont? = nil, hoverInfo: HoverInfo? = nil,
        xError: Error? = nil, yError: Error? = nil, zError: Error? = nil, xCalendar: Calendar? = nil,
        yCalendar: Calendar? = nil, zCalendar: Calendar? = nil, scene: Scene = .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.
    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.
    x

    Sets the x coordinates.
    y

    Sets the y coordinates.
    z

    Sets the z coordinates.
    text

    Sets text elements associated with each (x,y,z) triplet.
    textTemplate

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

    Sets text elements associated with each (x,y,z) triplet.
    hoverTemplate

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

    Determines the drawing mode for this scatter trace.
    surfaceAxis

    If -1, the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a Delaunay surface about the x, y, z respectively.
    surfaceColor

    Sets the surface fill color.
    projection

    connectGaps

    Determines whether or not gaps (i.e.
    line

    marker

    textPosition

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

    hoverInfo

    Determines which trace information appear on hover.
    xError

    yError

    zError

    xCalendar

    Sets the calendar system to use with x date data.
    yCalendar

    Sets the calendar system to use with y date data.
    zCalendar

    Sets the calendar system to use with z date data.
    scene

    Sets a reference between this trace’s 3D coordinate system and a 3D scene.

  • Encodes the object in a format compatible with Plotly.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws