StreamTube

public struct StreamTube<XYZData, UVWData> : Trace, SceneSubplot where XYZData : Plotable, UVWData : Plotable

Use a streamtube trace to visualize flow in a vector field.

Specify a vector field using 6 1D arrays of equal length, 3 position arrays x, y and z and 3 vector component arrays u, v, and w. By default, the tubes’ starting positions will be cut from the vector field’s x-z plane at its minimum y value. To specify your own starting position, use attributes starts.x, starts.y and starts.z. The color is encoded by the norm of (u, v, w), and the local radius by the divergence of (u, v, w).

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?

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

  • Undocumented

    Declaration

    Swift

    public var hoverLabel: HoverLabel?

  • Undocumented

    Declaration

    Swift

    public var stream: Stream?

  • 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 of the vector field.

    Declaration

    Swift

    public var x: XYZData?
  • y

    Sets the y coordinates of the vector field.

    Declaration

    Swift

    public var y: XYZData?
  • z

    Sets the z coordinates of the vector field.

    Declaration

    Swift

    public var z: XYZData?
  • u

    Sets the x components of the vector field.

    Declaration

    Swift

    public var u: UVWData?
  • v

    Sets the y components of the vector field.

    Declaration

    Swift

    public var v: UVWData?
  • w

    Sets the z components of the vector field.

    Declaration

    Swift

    public var w: UVWData?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Starts : Encodable

  • Undocumented

    Declaration

    Swift

    public var starts: Starts?

  • The maximum number of displayed segments in a streamtube.

    Declaration

    Swift

    public var maxDisplayed: Int?

  • The scaling factor for the streamtubes.

    The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions.

    Declaration

    Swift

    public var sizeReference: Double?

  • Sets a text element associated with this trace.

    If trace hoverinfo contains a text flag, this text element will be seen in all hover labels. Note that streamtube traces do not support array text values.

    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. variables tubex, tubey, tubez, tubeu, tubev, tubew, norm and divergence. 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 whether or not an item corresponding to this trace is shown in the legend.

    Declaration

    Swift

    public var showLegend: Bool?

  • Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

    Declaration

    Swift

    public var cAuto: Bool?

  • Sets the lower bound of the color domain.

    Value should have the same units as u/v/w norm and if set, cmax must be set as well.

    Declaration

    Swift

    public var cMin: Double?

  • Sets the upper bound of the color domain.

    Value should have the same units as u/v/w norm and if set, cmin must be set as well.

    Declaration

    Swift

    public var cMax: Double?

  • Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point.

    Value should have the same units as u/v/w norm. Has no effect when cauto is false.

    Declaration

    Swift

    public var cMiddle: Double?

  • 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, usecmin and cmax. 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?

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

  • Reverses the color mapping if true.

    If true, cmin will correspond to the last color in the array and cmax will correspond to the first color.

    Declaration

    Swift

    public var reverseScale: Bool?

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

    Declaration

    Swift

    public var showScale: Bool?

  • Undocumented

    Declaration

    Swift

    public var colorBar: ColorBar?

  • 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

  • Sets the opacity of the surface.

    Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

    Declaration

    Swift

    public var opacity: Double?

  • Undocumented

    Declaration

    Swift

    public var lightPosition: LightPosition?

  • Undocumented

    Declaration

    Swift

    public var lighting: Lighting?

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

    See more

    Declaration

    Swift

    public struct HoverInfo : OptionSet, Encodable

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

  • 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 StreamTube object from the most frequently used properties.

    Declaration

    Swift

    public init(name: String? = nil, x: XYZData? = nil, y: XYZData? = nil, z: XYZData? = nil, u:
        UVWData? = nil, v: UVWData? = nil, w: UVWData? = nil, text: Data<String>? = nil, hoverText:
        Data<String>? = nil, colorScale: ColorScale? = nil, reverseScale: Bool? = nil)

    Parameters

    name

    Sets the trace name.
    x

    Sets the x coordinates of the vector field.
    y

    Sets the y coordinates of the vector field.
    z

    Sets the z coordinates of the vector field.
    u

    Sets the x components of the vector field.
    v

    Sets the y components of the vector field.
    w

    Sets the z components of the vector field.
    text

    Sets a text element associated with this trace.
    hoverText

    Same as text.
    colorScale

    Sets the colorscale.
    reverseScale

    Reverses the color mapping if true.

  • Creates StreamTube object with specified properties.

    Declaration

    Swift

    public init(visible: Visible? = nil, legendGroup: String? = nil, name: String? = nil, uid:
        String? = nil, ids: [String]? = nil, customData: [String]? = nil, meta: Data<Anything>? = nil,
        hoverLabel: HoverLabel? = nil, stream: Stream? = nil, uiRevision: Anything? = nil, x: XYZData? =
        nil, y: XYZData? = nil, z: XYZData? = nil, u: UVWData? = nil, v: UVWData? = nil, w: UVWData? =
        nil, starts: Starts? = nil, maxDisplayed: Int? = nil, sizeReference: Double? = nil, text:
        Data<String>? = nil, hoverText: Data<String>? = nil, hoverTemplate: Data<String>? = nil,
        showLegend: Bool? = nil, cAuto: Bool? = nil, cMin: Double? = nil, cMax: Double? = nil, cMiddle:
        Double? = nil, colorScale: ColorScale? = nil, autoColorScale: Bool? = nil, reverseScale: Bool? =
        nil, showScale: Bool? = nil, colorBar: ColorBar? = nil, colorAxis: ColorAxis = .preset, opacity:
        Double? = nil, lightPosition: LightPosition? = nil, lighting: Lighting? = nil, hoverInfo:
        HoverInfo? = nil, scene: Scene = .preset)

    Parameters

    visible

    Determines whether or not this trace is visible.
    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.
    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 of the vector field.
    y

    Sets the y coordinates of the vector field.
    z

    Sets the z coordinates of the vector field.
    u

    Sets the x components of the vector field.
    v

    Sets the y components of the vector field.
    w

    Sets the z components of the vector field.
    starts

    maxDisplayed

    The maximum number of displayed segments in a streamtube.
    sizeReference

    The scaling factor for the streamtubes.
    text

    Sets a text element associated with this trace.
    hoverText

    Same as text.
    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.
    cAuto

    Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.
    cMin

    Sets the lower bound of the color domain.
    cMax

    Sets the upper bound of the color domain.
    cMiddle

    Sets the mid-point of the color domain by scaling cmin and/or cmax 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.
    opacity

    Sets the opacity of the surface.
    lightPosition

    lighting

    hoverInfo

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