Sankey

public struct Sankey : Trace, DomainSubplot

Sankey plots for network flow data analysis.

The nodes are specified in nodes and the links between sources and targets in links. The colors are set in nodes[i].color and links[i].color, otherwise defaults are used.

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 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?
  • 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?
  • 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. Note that this attribute is superseded by node.hoverinfo and node.hoverinfo for nodes and links respectively.

    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. Note that this attribute is superseded by node.hoverinfo and node.hoverinfo for nodes and links respectively.

    Declaration

    Swift

    public var hoverInfo: HoverInfo?
  • Undocumented

    Declaration

    Swift

    public var hoverLabel: HoverLabel?
  • Declaration

    Swift

    public var domain: Domain?
  • Sets the orientation of the Sankey diagram.

    Declaration

    Swift

    public var orientation: Orientation?
  • Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python.

    See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

    Declaration

    Swift

    public var valueFormat: String?
  • Adds a unit to follow the value in the hover tooltip.

    Add a space if a separation is necessary from the value.

    Declaration

    Swift

    public var valueSuffix: String?
  • If value is snap (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via nodepad.

    If value is perpendicular, the nodes can only move along a line perpendicular to the flow. If value is freeform, the nodes can freely move on the plane. If value is fixed, the nodes are stationary.

    See more

    Declaration

    Swift

    public enum Arrangement : String, Encodable
  • If value is snap (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via nodepad.

    If value is perpendicular, the nodes can only move along a line perpendicular to the flow. If value is freeform, the nodes can freely move on the plane. If value is fixed, the nodes are stationary.

    Declaration

    Swift

    public var arrangement: Arrangement?
  • Sets the font for node labels

    Declaration

    Swift

    public var textFont: Font?
  • The nodes of the Sankey plot.

    See more

    Declaration

    Swift

    public struct Node : Encodable
  • The nodes of the Sankey plot.

    Declaration

    Swift

    public var node: Node?
  • The links of the Sankey plot.

    See more

    Declaration

    Swift

    public struct Link : Encodable
  • The links of the Sankey plot.

    Declaration

    Swift

    public var link: Link?
  • Creates Sankey object with specified properties.

    Declaration

    Swift

    public init(visible: Visible? = nil, name: String? = nil, uid: String? = nil, ids: [String]? =
            nil, customData: [String]? = nil, meta: Data<Anything>? = nil, selectedPoints: Anything? = nil,
            stream: Stream? = nil, uiRevision: Anything? = nil, hoverInfo: HoverInfo? = nil, hoverLabel:
            HoverLabel? = nil, domain: Domain? = nil, orientation: Orientation? = nil, valueFormat: String?
            = nil, valueSuffix: String? = nil, arrangement: Arrangement? = nil, textFont: Font? = nil, node:
            Node? = nil, link: Link? = nil)

    Parameters

    visible

    Determines whether or not this trace is visible.

    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.

    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.

    hoverInfo

    Determines which trace information appear on hover.

    hoverLabel

    domain

    orientation

    Sets the orientation of the Sankey diagram.

    valueFormat

    Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python.

    valueSuffix

    Adds a unit to follow the value in the hover tooltip.

    arrangement

    If value is snap (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via nodepad.

    textFont

    Sets the font for node labels

    node

    The nodes of the Sankey plot.

    link

    The links of the Sankey plot.