Sankey
Miscellaneous
Arrangement
Default Value: snap
Type: enumerated
Enum Options: snap,perpendicular,freeform,fixed
Documentation: 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.
Path: data.index.arrangement
Value Format
Default Value: .3s
Type: string
Documentation: Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
Path: data.index.valueformat
Value Suffix
Default Value:
Type: string
Documentation: Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.
Path: data.index.valuesuffix
Hover Formatting
Hover Info
Default Value: all
Type: flaglist
Accept List: false
Flag Options:
Flag Single: all,none,skip
Documentation: 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.
Path: data.index.hoverinfo
Exclusive Options
Color
Type: color
Accept List: true
Documentation: 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.
Path: data.index.link.color
Hover Info
Default Value: all
Type: enumerated
Enum Options: all,none,skip
Documentation: 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.
Path: data.index.link.hoverinfo
Hover Template
Default Value:
Type: string
Accept List: true
Documentation: 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}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#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/tree/v2.2.3#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 source and target are node objects.Finally, the template string has access to 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>.
Path: data.index.link.hovertemplate
Label
Default Value: [List]
Type: any
Accept List: true
Documentation: The shown name of the link.
Path: data.index.link.label
Line Color
Default Value: #444
Type: color
Accept List: true
Documentation: Sets the color of the line around each link.
Path: data.index.link.line.color
Line Width
Default Value: 0
Type: number
Accept List: true
Min: 0
Documentation: Sets the width (in px) of the line around each link.
Path: data.index.link.line.width
Source
Default Value: [List]
Type: any
Accept List: true
Documentation: An integer number [0..nodes.length - 1] that represents the source node.
Path: data.index.link.source
Target
Default Value: [List]
Type: any
Accept List: true
Documentation: An integer number [0..nodes.length - 1] that represents the target node.
Path: data.index.link.target
Value
Default Value: [List]
Type: any
Accept List: true
Documentation: A numeric value representing the flow volume value.
Path: data.index.link.value
Basic Options
Name
Type: string
Documentation: Sets the trace name. The trace name appears as the legend item and on hover.
Path: data.index.name
Orientation
Default Value: h
Type: enumerated
Enum Options: v,h
Documentation: Sets the orientation of the Sankey diagram.
Path: data.index.orientation
Nodes Options
Color
Type: color
Accept List: true
Documentation: Sets the node color. It can be a single value, or an array for specifying color for each node. If node.color is omitted, then the default Plotly color palette will be cycled through to have a variety of colors. These defaults are not fully opaque, to allow some visibility of what is beneath the node.
Path: data.index.node.color
Label
Default Value: [List]
Type: any
Accept List: true
Documentation: The shown name of the node.
Path: data.index.node.label
Line Color
Default Value: #444
Type: color
Accept List: true
Documentation: Sets the color of the line around each node.
Path: data.index.node.line.color
Line Width
Default Value: 0.5
Type: number
Accept List: true
Min: 0
Documentation: Sets the width (in px) of the line around each node.
Path: data.index.node.line.width
Pad
Default Value: 20
Type: number
Accept List: false
Min: 0
Documentation: Sets the padding (in px) between the nodes.
Path: data.index.node.pad
Thickness
Default Value: 20
Type: number
Accept List: false
Min: 1
Documentation: Sets the thickness (in px) of the nodes.
Path: data.index.node.thickness
X
Default Value: [List]
Type: any
Accept List: true
Documentation: The normalized horizontal position of the node.
Path: data.index.node.x
Y
Default Value: [List]
Type: any
Accept List: true
Documentation: The normalized vertical position of the node.
Path: data.index.node.y
Text Formatting
Last updated