Link

public struct Link : Encodable

The links of the Sankey plot.

  • The shown name of the link.

    Declaration

    Swift

    public var label: [Double]?

  • Sets the link color.

    It can be a single value, or an array for specifying color for each link. If link.color is omitted, then by default, a translucent grey link will be used.

    Declaration

    Swift

    public var coloring: Coloring?

  • Assigns extra data to each link.

    Declaration

    Swift

    public var customData: [Double]?

  • Undocumented

    Declaration

    Swift

    public var line: VariableLine?

  • An integer number [0..nodes.length - 1] that represents the source node.

    Declaration

    Swift

    public var source: [Double]?

  • An integer number [0..nodes.length - 1] that represents the target node.

    Declaration

    Swift

    public var target: [Double]?

  • A numeric value representing the flow volume value.

    Declaration

    Swift

    public var value: [Double]?

  • Determines which trace information appear when hovering links.

    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 enum HoverInfo : String, Encodable

  • Determines which trace information appear when hovering links.

    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?

  • 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 value and label. 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

    See more

    Declaration

    Swift

    public struct ConcentrationScales : Encodable

  • Undocumented

    Declaration

    Swift

    public var colorScales: [ConcentrationScales]?

  • Creates Link object with specified properties.

    Declaration

    Swift

    public init(label: [Double]? = nil, coloring: Coloring? = nil, customData: [Double]? = nil,
        line: VariableLine? = nil, source: [Double]? = nil, target: [Double]? = nil, value: [Double]? =
        nil, hoverInfo: HoverInfo? = nil, hoverLabel: HoverLabel? = nil, hoverTemplate: Data<String>? =
        nil, colorScales: [ConcentrationScales]? = nil)

    Parameters

    label

    The shown name of the link.
    coloring

    Sets the link color.
    customData

    Assigns extra data to each link.
    line

    source

    An integer number [0..nodes.length - 1] that represents the source node.
    target

    An integer number [0..nodes.length - 1] that represents the target node.
    value

    A numeric value representing the flow volume value.
    hoverInfo

    Determines which trace information appear when hovering links.
    hoverLabel

    hoverTemplate

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