Python > Figure Reference > sankey Traces

Python Figure Reference: sankey Traces

A plotly.graph_objects.Sankey trace is a graph object in the figure's data list with any of the named arguments or attributes listed below.

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.

  • name
    Code: fig.update_traces(name=<VALUE>, selector=dict(type='sankey'))
    Type: string

    Sets the trace name. The trace name appears as the legend item and on hover.

  • visible
    Code: fig.update_traces(visible=<VALUE>, selector=dict(type='sankey'))
    Type: enumerated , one of ( True | False | "legendonly" )
    Default: True

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

  • legend
    Code: fig.update_traces(legend=<VALUE>, selector=dict(type='sankey'))
    Type: subplotid
    Default: legend

    Sets the reference to a legend to show this trace in. References to these legends are "legend", "legend2", "legend3", etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.

  • legendrank
    Code: fig.update_traces(legendrank=<VALUE>, selector=dict(type='sankey'))
    Type: number
    Default: 1000

    Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with "reversed" `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

  • legendgrouptitle
    Code: fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='sankey'))
    Type: dict containing one or more of the keys listed below.
    • font
      Code: fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='sankey'))
      Type: dict containing one or more of the keys listed below.

      Sets this legend group's title font.

      • color
        Code: fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='sankey'))
        Type: color
      • family
        Code: fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='sankey'))
        Type: string

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

      • lineposition
        Code: fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='sankey'))
        Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
        Examples: "under", "over", "under+over", "under+over+through", "none"
        Default: "none"

        Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.

      • shadow
        Code: fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='sankey'))
        Type: string
        Default: "none"

        Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.

      • size
        Code: fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='sankey'))
        Type: number greater than or equal to 1
      • style
        Code: fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='sankey'))
        Type: enumerated , one of ( "normal" | "italic" )
        Default: "normal"

        Sets whether a font should be styled with a normal or italic face from its family.

      • textcase
        Code: fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='sankey'))
        Type: enumerated , one of ( "normal" | "word caps" | "upper" | "lower" )
        Default: "normal"

        Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

      • variant
        Code: fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='sankey'))
        Type: enumerated , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
        Default: "normal"

        Sets the variant of the font.

      • weight
        Code: fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='sankey'))
        Type: integer between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • text
      Code: fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='sankey'))
      Type: string
      Default: ""

      Sets the title of the legend group.

  • legendwidth
    Code: fig.update_traces(legendwidth=<VALUE>, selector=dict(type='sankey'))
    Type: number greater than or equal to 0

    Sets the width (in px or fraction) of the legend for this trace.

  • ids
    Code: fig.update_traces(ids=<VALUE>, selector=dict(type='sankey'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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.

  • hoverinfo
    Code: fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='sankey'))
    Type: flaglist string. Any combination of joined with a "+" OR "all" or "none" or "skip".
    Examples: "", "", "+", "all"
    Default: "all"

    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.

  • meta
    Code: fig.update_traces(meta=<VALUE>, selector=dict(type='sankey'))
    Type: number or categorical coordinate 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.

  • customdata
    Code: fig.update_traces(customdata=<VALUE>, selector=dict(type='sankey'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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

  • domain
    Code: fig.update_traces(domain=dict(...), selector=dict(type='sankey'))
    Type: dict containing one or more of the keys listed below.
    • column
      Code: fig.update_traces(domain_column=<VALUE>, selector=dict(type='sankey'))
      Type: integer greater than or equal to 0
      Default: 0

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

    • row
      Code: fig.update_traces(domain_row=<VALUE>, selector=dict(type='sankey'))
      Type: integer greater than or equal to 0
      Default: 0

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

    • x
      Code: fig.update_traces(domain_x=list(...), selector=dict(type='sankey'))
      Type: list
      Default: [0, 1]

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

    • y
      Code: fig.update_traces(domain_y=list(...), selector=dict(type='sankey'))
      Type: list
      Default: [0, 1]

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

  • orientation
    Code: fig.update_traces(orientation=<VALUE>, selector=dict(type='sankey'))
    Type: enumerated , one of ( "v" | "h" )
    Default: "h"

    Sets the orientation of the Sankey diagram.

  • node
    Code: fig.update_traces(node=dict(...), selector=dict(type='sankey'))
    Type: dict containing one or more of the keys listed below.

    The nodes of the Sankey plot.

    • align
      Code: fig.update_traces(node_align=<VALUE>, selector=dict(type='sankey'))
      Type: enumerated , one of ( "justify" | "left" | "right" | "center" )
      Default: "justify"

      Sets the alignment method used to position the nodes along the horizontal axis.

    • color
      Code: fig.update_traces(node_color=<VALUE>, selector=dict(type='sankey'))
      Type: color or array of colors

      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
      Code: fig.update_traces(node_customdata=<VALUE>, selector=dict(type='sankey'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

      Assigns extra data to each node.

    • groups
      Code: fig.update_traces(node_groups=list(...), selector=dict(type='sankey'))
      Type: list
      Default: []

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

    • hoverinfo
      Code: fig.update_traces(node_hoverinfo=<VALUE>, selector=dict(type='sankey'))
      Type: enumerated , one of ( "all" | "none" | "skip" )
      Default: "all"

      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.

    • hoverlabel
      Code: fig.update_traces(node_hoverlabel=dict(...), selector=dict(type='sankey'))
      Type: dict containing one or more of the keys listed below.
      • align
        Code: fig.update_traces(node_hoverlabel_align=<VALUE>, selector=dict(type='sankey'))
        Type: enumerated or array of enumerateds , one of ( "left" | "right" | "auto" )
        Default: "auto"

        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

      • bgcolor
        Code: fig.update_traces(node_hoverlabel_bgcolor=<VALUE>, selector=dict(type='sankey'))
        Type: color or array of colors

        Sets the background color of the hover labels for this trace

      • bordercolor
        Code: fig.update_traces(node_hoverlabel_bordercolor=<VALUE>, selector=dict(type='sankey'))
        Type: color or array of colors

        Sets the border color of the hover labels for this trace.

      • font
        Code: fig.update_traces(node_hoverlabel_font=dict(...), selector=dict(type='sankey'))
        Type: dict containing one or more of the keys listed below.

        Sets the font used in hover labels.

        • color
          Code: fig.update_traces(node_hoverlabel_font_color=<VALUE>, selector=dict(type='sankey'))
          Type: color or array of colors
        • family
          Code: fig.update_traces(node_hoverlabel_font_family=<VALUE>, selector=dict(type='sankey'))
          Type: string or array of strings

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

        • lineposition
          Code: fig.update_traces(node_hoverlabel_font_lineposition=<VALUE>, selector=dict(type='sankey'))
          Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
          Examples: "under", "over", "under+over", "under+over+through", "none"
          Default: "none"

          Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.

        • shadow
          Code: fig.update_traces(node_hoverlabel_font_shadow=<VALUE>, selector=dict(type='sankey'))
          Type: string or array of strings
          Default: "none"

          Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.

        • size
          Code: fig.update_traces(node_hoverlabel_font_size=<VALUE>, selector=dict(type='sankey'))
          Type: number or array of numbers greater than or equal to 1
        • style
          Code: fig.update_traces(node_hoverlabel_font_style=<VALUE>, selector=dict(type='sankey'))
          Type: enumerated or array of enumerateds , one of ( "normal" | "italic" )
          Default: "normal"

          Sets whether a font should be styled with a normal or italic face from its family.

        • textcase
          Code: fig.update_traces(node_hoverlabel_font_textcase=<VALUE>, selector=dict(type='sankey'))
          Type: enumerated or array of enumerateds , one of ( "normal" | "word caps" | "upper" | "lower" )
          Default: "normal"

          Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

        • variant
          Code: fig.update_traces(node_hoverlabel_font_variant=<VALUE>, selector=dict(type='sankey'))
          Type: enumerated or array of enumerateds , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
          Default: "normal"

          Sets the variant of the font.

        • weight
          Code: fig.update_traces(node_hoverlabel_font_weight=<VALUE>, selector=dict(type='sankey'))
          Type: integer or array of integers between or equal to 1 and 1000
          Default: normal

          Sets the weight (or boldness) of the font.

      • namelength
        Code: fig.update_traces(node_hoverlabel_namelength=<VALUE>, selector=dict(type='sankey'))
        Type: integer or array of integers greater than or equal to -1
        Default: 15

        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.

    • hovertemplate
      Code: fig.update_traces(node_hovertemplate=<VALUE>, selector=dict(type='sankey'))
      Type: string or array of strings
      Default: ""

      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 `sourceLinks` and `targetLinks` are arrays of link 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 "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.

    • label
      Code: fig.update_traces(node_label=<VALUE>, selector=dict(type='sankey'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.
      Default:

      The shown name of the node.

    • line
      Code: fig.update_traces(node_line=dict(...), selector=dict(type='sankey'))
      Type: dict containing one or more of the keys listed below.
      • color
        Code: fig.update_traces(node_line_color=<VALUE>, selector=dict(type='sankey'))
        Type: color or array of colors
        Default: "#444"

        Sets the color of the `line` around each `node`.

      • width
        Code: fig.update_traces(node_line_width=<VALUE>, selector=dict(type='sankey'))
        Type: number or array of numbers greater than or equal to 0
        Default: 0.5

        Sets the width (in px) of the `line` around each `node`.

    • pad
      Code: fig.update_traces(node_pad=<VALUE>, selector=dict(type='sankey'))
      Type: number greater than or equal to 0
      Default: 20

      Sets the padding (in px) between the `nodes`.

    • thickness
      Code: fig.update_traces(node_thickness=<VALUE>, selector=dict(type='sankey'))
      Type: number greater than or equal to 1
      Default: 20

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

    • x
      Code: fig.update_traces(node_x=<VALUE>, selector=dict(type='sankey'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.
      Default:

      The normalized horizontal position of the node.

    • y
      Code: fig.update_traces(node_y=<VALUE>, selector=dict(type='sankey'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.
      Default:

      The normalized vertical position of the node.

  • link
    Code: fig.update_traces(link=dict(...), selector=dict(type='sankey'))
    Type: dict containing one or more of the keys listed below.

    The links of the Sankey plot.

    • arrowlen
      Code: fig.update_traces(link_arrowlen=<VALUE>, selector=dict(type='sankey'))
      Type: number greater than or equal to 0
      Default: 0

      Sets the length (in px) of the links arrow, if 0 no arrow will be drawn.

    • color
      Code: fig.update_traces(link_color=<VALUE>, selector=dict(type='sankey'))
      Type: color or array of colors

      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.

    • colorscales
      Code: fig.update_traces(link_colorscales=list(...), selector=dict(type='sankey'))
      Type: list of dict where each dict has one or more of the keys listed below.
      • cmax
        Parent: data[type=sankey].link.colorscales[]
        Type: number
        Default: 1

        Sets the upper bound of the color domain.

      • cmin
        Parent: data[type=sankey].link.colorscales[]
        Type: number
        Default: 0

        Sets the lower bound of the color domain.

      • colorscale
        Parent: data[type=sankey].link.colorscales[]
        Type: colorscale
        Default: [[0, white], [1, black], ]

        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, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

      • label
        Parent: data[type=sankey].link.colorscales[]
        Type: string
        Default: ""

        The label of the links to color based on their concentration within a flow.

      • name
        Parent: data[type=sankey].link.colorscales[]
        Type: string

        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: False` or `enabled: False` to hide it). Has no effect outside of a template.

      • templateitemname
        Parent: data[type=sankey].link.colorscales[]
        Type: string

        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: False` or `enabled: False` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: True`.

    • customdata
      Code: fig.update_traces(link_customdata=<VALUE>, selector=dict(type='sankey'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

      Assigns extra data to each link.

    • hovercolor
      Code: fig.update_traces(link_hovercolor=<VALUE>, selector=dict(type='sankey'))
      Type: color or array of colors

      Sets the `link` hover color. It can be a single value, or an array for specifying hover colors for each `link`. If `link.hovercolor` is omitted, then by default, links will become slightly more opaque when hovered over.

    • hoverinfo
      Code: fig.update_traces(link_hoverinfo=<VALUE>, selector=dict(type='sankey'))
      Type: enumerated , one of ( "all" | "none" | "skip" )
      Default: "all"

      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.

    • hoverlabel
      Code: fig.update_traces(link_hoverlabel=dict(...), selector=dict(type='sankey'))
      Type: dict containing one or more of the keys listed below.
      • align
        Code: fig.update_traces(link_hoverlabel_align=<VALUE>, selector=dict(type='sankey'))
        Type: enumerated or array of enumerateds , one of ( "left" | "right" | "auto" )
        Default: "auto"

        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

      • bgcolor
        Code: fig.update_traces(link_hoverlabel_bgcolor=<VALUE>, selector=dict(type='sankey'))
        Type: color or array of colors

        Sets the background color of the hover labels for this trace

      • bordercolor
        Code: fig.update_traces(link_hoverlabel_bordercolor=<VALUE>, selector=dict(type='sankey'))
        Type: color or array of colors

        Sets the border color of the hover labels for this trace.

      • font
        Code: fig.update_traces(link_hoverlabel_font=dict(...), selector=dict(type='sankey'))
        Type: dict containing one or more of the keys listed below.

        Sets the font used in hover labels.

        • color
          Code: fig.update_traces(link_hoverlabel_font_color=<VALUE>, selector=dict(type='sankey'))
          Type: color or array of colors
        • family
          Code: fig.update_traces(link_hoverlabel_font_family=<VALUE>, selector=dict(type='sankey'))
          Type: string or array of strings

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

        • lineposition
          Code: fig.update_traces(link_hoverlabel_font_lineposition=<VALUE>, selector=dict(type='sankey'))
          Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
          Examples: "under", "over", "under+over", "under+over+through", "none"
          Default: "none"

          Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.

        • shadow
          Code: fig.update_traces(link_hoverlabel_font_shadow=<VALUE>, selector=dict(type='sankey'))
          Type: string or array of strings
          Default: "none"

          Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.

        • size
          Code: fig.update_traces(link_hoverlabel_font_size=<VALUE>, selector=dict(type='sankey'))
          Type: number or array of numbers greater than or equal to 1
        • style
          Code: fig.update_traces(link_hoverlabel_font_style=<VALUE>, selector=dict(type='sankey'))
          Type: enumerated or array of enumerateds , one of ( "normal" | "italic" )
          Default: "normal"

          Sets whether a font should be styled with a normal or italic face from its family.

        • textcase
          Code: fig.update_traces(link_hoverlabel_font_textcase=<VALUE>, selector=dict(type='sankey'))
          Type: enumerated or array of enumerateds , one of ( "normal" | "word caps" | "upper" | "lower" )
          Default: "normal"

          Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

        • variant
          Code: fig.update_traces(link_hoverlabel_font_variant=<VALUE>, selector=dict(type='sankey'))
          Type: enumerated or array of enumerateds , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
          Default: "normal"

          Sets the variant of the font.

        • weight
          Code: fig.update_traces(link_hoverlabel_font_weight=<VALUE>, selector=dict(type='sankey'))
          Type: integer or array of integers between or equal to 1 and 1000
          Default: normal

          Sets the weight (or boldness) of the font.

      • namelength
        Code: fig.update_traces(link_hoverlabel_namelength=<VALUE>, selector=dict(type='sankey'))
        Type: integer or array of integers greater than or equal to -1
        Default: 15

        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.

    • hovertemplate
      Code: fig.update_traces(link_hovertemplate=<VALUE>, selector=dict(type='sankey'))
      Type: string or array of strings
      Default: ""

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

    • label
      Code: fig.update_traces(link_label=<VALUE>, selector=dict(type='sankey'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.
      Default:

      The shown name of the link.

    • line
      Code: fig.update_traces(link_line=dict(...), selector=dict(type='sankey'))
      Type: dict containing one or more of the keys listed below.
      • color
        Code: fig.update_traces(link_line_color=<VALUE>, selector=dict(type='sankey'))
        Type: color or array of colors
        Default: "#444"

        Sets the color of the `line` around each `link`.

      • width
        Code: fig.update_traces(link_line_width=<VALUE>, selector=dict(type='sankey'))
        Type: number or array of numbers greater than or equal to 0
        Default: 0

        Sets the width (in px) of the `line` around each `link`.

    • source
      Code: fig.update_traces(link_source=<VALUE>, selector=dict(type='sankey'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.
      Default:

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

    • target
      Code: fig.update_traces(link_target=<VALUE>, selector=dict(type='sankey'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.
      Default:

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

    • value
      Code: fig.update_traces(link_value=<VALUE>, selector=dict(type='sankey'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.
      Default:

      A numeric value representing the flow volume value.

  • textfont
    Code: fig.update_traces(textfont=dict(...), selector=dict(type='sankey'))
    Type: dict containing one or more of the keys listed below.

    Sets the font for node labels

    • color
      Code: fig.update_traces(textfont_color=<VALUE>, selector=dict(type='sankey'))
      Type: color
    • family
      Code: fig.update_traces(textfont_family=<VALUE>, selector=dict(type='sankey'))
      Type: string

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

    • lineposition
      Code: fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='sankey'))
      Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
      Examples: "under", "over", "under+over", "under+over+through", "none"
      Default: "none"

      Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.

    • shadow
      Code: fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='sankey'))
      Type: string
      Default: "auto"

      Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.

    • size
      Code: fig.update_traces(textfont_size=<VALUE>, selector=dict(type='sankey'))
      Type: number greater than or equal to 1
    • style
      Code: fig.update_traces(textfont_style=<VALUE>, selector=dict(type='sankey'))
      Type: enumerated , one of ( "normal" | "italic" )
      Default: "normal"

      Sets whether a font should be styled with a normal or italic face from its family.

    • textcase
      Code: fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='sankey'))
      Type: enumerated , one of ( "normal" | "word caps" | "upper" | "lower" )
      Default: "normal"

      Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

    • variant
      Code: fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='sankey'))
      Type: enumerated , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
      Default: "normal"

      Sets the variant of the font.

    • weight
      Code: fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='sankey'))
      Type: integer between or equal to 1 and 1000
      Default: normal

      Sets the weight (or boldness) of the font.

  • selectedpoints
    Code: fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='sankey'))
    Type: number or categorical coordinate string

    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.

  • arrangement
    Code: fig.update_traces(arrangement=<VALUE>, selector=dict(type='sankey'))
    Type: enumerated , one of ( "snap" | "perpendicular" | "freeform" | "fixed" )
    Default: "snap"

    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.

  • hoverlabel
    Code: fig.update_traces(hoverlabel=dict(...), selector=dict(type='sankey'))
    Type: dict containing one or more of the keys listed below.
    • align
      Code: fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='sankey'))
      Type: enumerated or array of enumerateds , one of ( "left" | "right" | "auto" )
      Default: "auto"

      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

    • bgcolor
      Code: fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='sankey'))
      Type: color or array of colors

      Sets the background color of the hover labels for this trace

    • bordercolor
      Code: fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='sankey'))
      Type: color or array of colors

      Sets the border color of the hover labels for this trace.

    • font
      Code: fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='sankey'))
      Type: dict containing one or more of the keys listed below.

      Sets the font used in hover labels.

      • color
        Code: fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='sankey'))
        Type: color or array of colors
      • family
        Code: fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='sankey'))
        Type: string or array of strings

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

      • lineposition
        Code: fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='sankey'))
        Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
        Examples: "under", "over", "under+over", "under+over+through", "none"
        Default: "none"

        Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.

      • shadow
        Code: fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='sankey'))
        Type: string or array of strings
        Default: "none"

        Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.

      • size
        Code: fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='sankey'))
        Type: number or array of numbers greater than or equal to 1
      • style
        Code: fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='sankey'))
        Type: enumerated or array of enumerateds , one of ( "normal" | "italic" )
        Default: "normal"

        Sets whether a font should be styled with a normal or italic face from its family.

      • textcase
        Code: fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='sankey'))
        Type: enumerated or array of enumerateds , one of ( "normal" | "word caps" | "upper" | "lower" )
        Default: "normal"

        Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

      • variant
        Code: fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='sankey'))
        Type: enumerated or array of enumerateds , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
        Default: "normal"

        Sets the variant of the font.

      • weight
        Code: fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='sankey'))
        Type: integer or array of integers between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • namelength
      Code: fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='sankey'))
      Type: integer or array of integers greater than or equal to -1
      Default: 15

      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.

  • valueformat
    Code: fig.update_traces(valueformat=<VALUE>, selector=dict(type='sankey'))
    Type: string
    Default: ".3s"

    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.

  • valuesuffix
    Code: fig.update_traces(valuesuffix=<VALUE>, selector=dict(type='sankey'))
    Type: string
    Default: ""

    Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.

  • uirevision
    Code: fig.update_traces(uirevision=<VALUE>, selector=dict(type='sankey'))
    Type: number or categorical coordinate string

    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.