ScatterGL

public struct ScatterGL<XData, YData> : Trace, XYSubplot where XData : Plotable, YData : Plotable

The data visualized as scatter point or lines is set in x and y using the WebGL plotting engine.

Bubble charts are achieved by setting marker.size and/or marker.color to a numerical arrays.

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

    Sets the x coordinates.

    Declaration

    Swift

    public var x: XData?
  • x0

    Alternate to x.

    Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

    Declaration

    Swift

    public var x0: Anything?
  • dx

    Sets the x coordinate step.

    See x0 for more info.

    Declaration

    Swift

    public var dx: Double?
  • y

    Sets the y coordinates.

    Declaration

    Swift

    public var y: YData?
  • y0

    Alternate to y.

    Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

    Declaration

    Swift

    public var y0: Anything?
  • dy

    Sets the y coordinate step.

    See y0 for more info.

    Declaration

    Swift

    public var dy: Double?

  • Only relevant when the axis type is date.

    Sets the period positioning in milliseconds or M on the x axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

    Declaration

    Swift

    public var xPeriod: Anything?

  • Only relevant when the axis type is date.

    Sets the period positioning in milliseconds or M on the y axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

    Declaration

    Swift

    public var yPeriod: Anything?

  • Only relevant when the axis type is date.

    Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

    Declaration

    Swift

    public var xPeriod0: Anything?

  • Only relevant when the axis type is date.

    Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

    Declaration

    Swift

    public var yPeriod0: Anything?

  • Only relevant when the axis type is date.

    Sets the alignment of data points on the x axis.

    Declaration

    Swift

    public var xPeriodAlignment: XPeriodAlignment?

  • Only relevant when the axis type is date.

    Sets the alignment of data points on the y axis.

    Declaration

    Swift

    public var yPeriodAlignment: YPeriodAlignment?

  • Sets text elements associated with each (x,y) 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 (x,y) 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>?

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

    Declaration

    Swift

    public var hoverText: Data<String>?

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

    Declaration

    Swift

    public var textPosition: TextPosition?

  • Sets the text font.

    Declaration

    Swift

    public var textFont: VariableFont?

  • Determines the drawing mode for this scatter trace.

    Declaration

    Swift

    public var mode: Mode?

  • Undocumented

    See more

    Declaration

    Swift

    public struct ShapedDashedLine : Encodable

  • Undocumented

    Declaration

    Swift

    public var line: ShapedDashedLine?

  • Undocumented

    Declaration

    Swift

    public var marker: SymbolicMarker?

  • Determines whether or not gaps (i.e.

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

    Declaration

    Swift

    public var connectGaps: Bool?

  • Sets the area to fill with a solid color.

    Defaults to none unless this trace is stacked, then it gets tonexty (tonextx) if orientation is v (h) Use with fillcolor if not none. tozerox and tozeroy fill to x=0 and y=0 respectively. tonextx and tonexty fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like tozerox and tozeroy. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. tonext fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like toself if there is no trace before it. tonext should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple stackgroups or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

    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?

  • Sets the opacity of the trace.

    Declaration

    Swift

    public var opacity: Double?

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

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

  • Undocumented

    Declaration

    Swift

    public var xError: Error?

  • Undocumented

    Declaration

    Swift

    public var yError: 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 a reference between this trace’s x coordinates and a 2D cartesian x axis.

    If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

    Declaration

    Swift

    public var xAxis: XAxis

  • Sets a reference between this trace’s y coordinates and a 2D cartesian y axis.

    If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

    Declaration

    Swift

    public var yAxis: YAxis

  • Creates ScatterGL object from the most frequently used properties.

    Declaration

    Swift

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

    Parameters

    name

    Sets the trace name.
    x

    Sets the x coordinates.
    y

    Sets the y coordinates.
    text

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

    Sets hover text elements associated with each (x,y) pair.
    mode

    Determines the drawing mode for this scatter trace.
    line

    marker

  • Creates ScatterGL 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, x: XData? = nil, x0: Anything? = nil, dx: Double? = nil, y: YData? = nil, y0: Anything? =
        nil, dy: Double? = nil, xPeriod: Anything? = nil, yPeriod: Anything? = nil, xPeriod0: Anything?
        = nil, yPeriod0: Anything? = nil, xPeriodAlignment: XPeriodAlignment? = nil, yPeriodAlignment:
        YPeriodAlignment? = nil, text: Data<String>? = nil, hoverText: Data<String>? = nil,
        textPosition: TextPosition? = nil, textFont: VariableFont? = nil, mode: Mode? = nil, line:
        ShapedDashedLine? = nil, marker: SymbolicMarker? = nil, connectGaps: Bool? = nil, fill: Fill? =
        nil, fillColor: Color? = nil, selected: Selected? = nil, unselected: Unselected? = nil, opacity:
        Double? = nil, hoverTemplate: Data<String>? = nil, textTemplate: Data<String>? = nil, xError:
        Error? = nil, yError: Error? = nil, xCalendar: Calendar? = nil, yCalendar: Calendar? = nil,
        xAxis: XAxis = .preset, yAxis: YAxis = .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.
    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.
    x

    Sets the x coordinates.
    x0

    Alternate to x.
    dx

    Sets the x coordinate step.
    y

    Sets the y coordinates.
    y0

    Alternate to y.
    dy

    Sets the y coordinate step.
    xPeriod

    Only relevant when the axis type is date.
    yPeriod

    Only relevant when the axis type is date.
    xPeriod0

    Only relevant when the axis type is date.
    yPeriod0

    Only relevant when the axis type is date.
    xPeriodAlignment

    Only relevant when the axis type is date.
    yPeriodAlignment

    Only relevant when the axis type is date.
    text

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

    Sets hover text elements associated with each (x,y) pair.
    textPosition

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

    Sets the text font.
    mode

    Determines the drawing mode for this scatter trace.
    line

    marker

    connectGaps

    Determines whether or not gaps (i.e.
    fill

    Sets the area to fill with a solid color.
    fillColor

    Sets the fill color.
    selected

    unselected

    opacity

    Sets the opacity of the trace.
    hoverTemplate

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

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

    yError

    xCalendar

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

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

    Sets a reference between this trace’s x coordinates and a 2D cartesian x axis.
    yAxis

    Sets a reference between this trace’s y coordinates and a 2D cartesian y axis.

  • Encodes the object in a format compatible with Plotly.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws