Live Chat

We'll need to share your messages (and your email address if you're logged in) with our live chat provider, Drift. Here's their privacy policy.

If you don't want to do this, you can email us instead at contact@anvil.works.

plotly.graph_objs.sankey Module

Functions

plotly.graph_objs.sankey.Domain([x=], [y=], [row=], [column=]) → Domain

Create a new ‘Domain’ object

  • x - Sets the horizontal domain of this sankey trace (in plot fraction).

  • y - Sets the vertical domain of this sankey trace (in plot fraction).

  • row - If there is a layout grid, use the domain for this row in the grid for this sankey trace .

  • column - If there is a layout grid, use the domain for this column in the grid for this sankey trace .


plotly.graph_objs.sankey.Hoverlabel([bgcolor=], [bordercolor=], [font=], [align=], [namelength=], [bgcolorsrc=], [bordercolorsrc=], [alignsrc=], [namelengthsrc=]) → Hoverlabel

Create a new ‘Hoverlabel’ object

  • bgcolor - Sets the background color of the hover labels for this trace

  • bordercolor - Sets the border color of the hover labels for this trace.

  • font - Sets the font used in hover labels.

  • align - Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

  • namelength - Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.

  • bgcolorsrc - Sets the source reference on Chart Studio Cloud for bgcolor .

  • bordercolorsrc - Sets the source reference on Chart Studio Cloud for bordercolor .

  • alignsrc - Sets the source reference on Chart Studio Cloud for align .

  • namelengthsrc - Sets the source reference on Chart Studio Cloud for namelength .


Create a new ‘Link’ object

  • label - The shown name of the link.

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

  • customdata - Assigns extra data to each link.

  • 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. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • hovertemplate - 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 "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.

  • labelsrc - Sets the source reference on Chart Studio Cloud for label .

  • colorsrc - Sets the source reference on Chart Studio Cloud for color .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • sourcesrc - Sets the source reference on Chart Studio Cloud for source .

  • targetsrc - Sets the source reference on Chart Studio Cloud for target .

  • valuesrc - Sets the source reference on Chart Studio Cloud for value .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.sankey.Node([label=], [groups=], [x=], [y=], [color=], [customdata=], [line=], [pad=], [thickness=], [hoverinfo=], [hoverlabel=], [hovertemplate=], [labelsrc=], [xsrc=], [ysrc=], [colorsrc=], [customdatasrc=], [hovertemplatesrc=]) → Node

Create a new ‘Node’ object

  • label - The shown name of the node.

  • groups - Groups of nodes. Each group is defined by an array with the indices of the nodes it contains. Multiple groups can be specified.

  • x - The normalized horizontal position of the node.

  • y - The normalized vertical position of the node.

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

  • customdata - Assigns extra data to each node.

  • pad - Sets the padding (in px) between the `nodes`.

  • thickness - Sets the thickness (in px) of the `nodes`.

  • hoverinfo - Determines which trace information appear when hovering nodes. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • hovertemplate - 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 "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.

  • labelsrc - Sets the source reference on Chart Studio Cloud for label .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • colorsrc - Sets the source reference on Chart Studio Cloud for color .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.sankey.Stream([token=], [maxpoints=]) → Stream

Create a new ‘Stream’ object

  • token - The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

  • maxpoints - Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.


plotly.graph_objs.sankey.Textfont([family=], [size=], [color=]) → Textfont

Create a new ‘Textfont’ object

  • family - HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.


Globals





plotly.graph_objs.sankey