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


                    
                    
                    showLegend

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

Declaration

Swift

public var showLegend: Bool?


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


                    
                    
                    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?


                    
                    
                    hoverLabel

Undocumented

Declaration

Swift

public var hoverLabel: HoverLabel?


                    
                    
                    stream

Undocumented

Declaration

Swift

public var stream: Stream?


                    
                    
                    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?

Sets the x coordinates.

Declaration

Swift

public var x: XYData?

Sets the y coordinates.

Declaration

Swift

public var y: XYData?

xy

Faster alternative to specifying x and y separately.

If supplied, it must be a typed Float32Array array that represents points such that xy[i * 2] = x[i] and xy[i * 2 + 1] = y[i]

Declaration

Swift

public var xy: XYData?


                    
                    
                    indices

A sequential value, 0..n, supply it to avoid creating this array inside plotting.

If specified, it must be a typed Int32Array array. Its length must be equal to or greater than the number of points. For the best performance and memory use, create one large indices typed array that is guaranteed to be at least as long as the largest number of points during use, and reuse it on each Plotly.restyle() call.

Declaration

Swift

public var indices: [Int]?


                    
                    
                    xBounds

Specify xbounds in the shape of [xMin, xMax] to avoid looping through thexy` typed array.

Use it in conjunction with xy and ybounds for the performance benefits.

Declaration

Swift

public var xBounds: [Double]?


                    
                    
                    yBounds

Specify ybounds in the shape of [yMin, yMax] to avoid looping through thexy` typed array.

Use it in conjunction with xy and xbounds for the performance benefits.

Declaration

Swift

public var yBounds: [Double]?


                    
                    
                    text

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


                    
                    
                    Marker

Undocumented

Declaration

Swift

public struct Marker : Encodable


                    
                    
                    marker

Undocumented

Declaration

Swift

public var marker: Marker?


                    
                    
                    xAxis

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


                    
                    
                    yAxis

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


                    
                    
                    init(name:x:y:xy:text:marker:)

Creates PointCloud object from the most frequently used properties.

Declaration

Swift

public init(name: String? = nil, x: XYData? = nil, y: XYData? = nil, xy: XYData? = nil, text:
        Data<String>? = nil, marker: Marker? = nil)

Parameters

`name`	Sets the trace name.
`x`	Sets the x coordinates.
`y`	Sets the y coordinates.
`xy`	Faster alternative to specifying `x` and `y` separately.
`text`	Sets text elements associated with each (x,y) pair.
`marker`


                    
                    
                    init(visible:showLegend:legendGroup:opacity:name:uid:ids:customData:meta:hoverInfo:hoverLabel:stream:uiRevision:x:y:xy:indices:xBounds:yBounds:text:marker:xAxis:yAxis:)

Creates PointCloud 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, hoverInfo: HoverInfo? = nil,
        hoverLabel: HoverLabel? = nil, stream: Stream? = nil, uiRevision: Anything? = nil, x: XYData? =
        nil, y: XYData? = nil, xy: XYData? = nil, indices: [Int]? = nil, xBounds: [Double]? = nil,
        yBounds: [Double]? = nil, text: Data<String>? = nil, marker: Marker? = 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.
`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.
`hoverInfo`	Determines which trace information appear on hover.
`hoverLabel`
`stream`
`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.
`xy`	Faster alternative to specifying `x` and `y` separately.
`indices`	A sequential value, 0..n, supply it to avoid creating this array inside plotting.
`xBounds`	Specify `xbounds` in the shape of `[xMin, xMax] to avoid looping through the`xy` typed array.
`yBounds`	Specify `ybounds` in the shape of `[yMin, yMax] to avoid looping through the`xy` typed array.
`text`	Sets text elements associated with each (x,y) pair.
`marker`
`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.


                    
                    
                    encode(to:)

Encodes the object in a format compatible with Plotly.

Declaration

Swift

public func encode(to encoder: Encoder) throws