Python Figure Reference: waterfall Traces

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

Draws waterfall trace which is useful graph to displays the contribution of various elements (either positive or negative) in a bar chart. The data visualized by the span of the bars is set in `y` if `orientation` is set to "v" (the default) and the labels are set in `x`. By setting `orientation` to "h", the roles are interchanged.

  • name
    Code: fig.update_traces(name=<VALUE>, selector=dict(type='waterfall'))
    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='waterfall'))
    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).

  • showlegend
    Code: fig.update_traces(showlegend=<VALUE>, selector=dict(type='waterfall'))
    Type: boolean
    Default: True

    Determines whether or not an item corresponding to this trace is shown in the legend.

  • legend
    Code: fig.update_traces(legend=<VALUE>, selector=dict(type='waterfall'))
    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='waterfall'))
    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.

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

    Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

  • legendgrouptitle
    Code: fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='waterfall'))
    Type: dict containing one or more of the keys listed below.
    • font
      Code: fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='waterfall'))
      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='waterfall'))
        Type: color
      • family
        Code: fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='waterfall'))
        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".

      • size
        Code: fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='waterfall'))
        Type: number greater than or equal to 1
    • text
      Code: fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='waterfall'))
      Type: string
      Default: ""

      Sets the title of the legend group.

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

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

  • opacity
    Code: fig.update_traces(opacity=<VALUE>, selector=dict(type='waterfall'))
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Code: fig.update_traces(ids=<VALUE>, selector=dict(type='waterfall'))
    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.

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

    Sets the x coordinates.

  • x0
    Code: fig.update_traces(x0=<VALUE>, selector=dict(type='waterfall'))
    Type: number or categorical coordinate string
    Default: 0

    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

  • dx
    Code: fig.update_traces(dx=<VALUE>, selector=dict(type='waterfall'))
    Type: number
    Default: 1

    Sets the x coordinate step. See `x0` for more info.

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

    Sets the y coordinates.

  • y0
    Code: fig.update_traces(y0=<VALUE>, selector=dict(type='waterfall'))
    Type: number or categorical coordinate string
    Default: 0

    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

  • dy
    Code: fig.update_traces(dy=<VALUE>, selector=dict(type='waterfall'))
    Type: number
    Default: 1

    Sets the y coordinate step. See `y0` for more info.

  • base
    Code: fig.update_traces(base=<VALUE>, selector=dict(type='waterfall'))
    Type: number

    Sets where the bar base is drawn (in position axis units).

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

    Sets the bar width (in position axis units).

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

    An array containing types of values. By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed.

  • offset
    Code: fig.update_traces(offset=<VALUE>, selector=dict(type='waterfall'))
    Type: number or array of numbers

    Shifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead.

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

    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.

  • textposition
    Code: fig.update_traces(textposition=<VALUE>, selector=dict(type='waterfall'))
    Type: enumerated or array of enumerateds , one of ( "inside" | "outside" | "auto" | "none" )
    Default: "auto"

    Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If "none", no text appears.

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

    Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. 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-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. Every attributes that can be specified per-point (the ones that are `arrayOk: True`) are available. Finally, the template string has access to variables `initial`, `delta`, `final` and `label`.

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

    Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.

  • hoverinfo
    Code: fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='waterfall'))
    Type: flaglist string. Any combination of "name", "x", "y", "text", "initial", "delta", "final" joined with a "+" OR "all" or "none" or "skip".
    Examples: "name", "x", "name+x", "name+x+y", "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.

  • hovertemplate
    Code: fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='waterfall'))
    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. Finally, the template string has access to variables `initial`, `delta` and `final`. 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>`.

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

    Sets the hover text formatting rulefor `x` 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. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"By default the values are formatted using `xaxis.hoverformat`.

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

    Sets the hover text formatting rulefor `y` 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. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"By default the values are formatted using `yaxis.hoverformat`.

  • meta
    Code: fig.update_traces(meta=<VALUE>, selector=dict(type='waterfall'))
    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='waterfall'))
    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

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

    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.

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

    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.

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

    Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal).

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

    Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

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

    Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

  • xperiod
    Code: fig.update_traces(xperiod=<VALUE>, selector=dict(type='waterfall'))
    Type: number or categorical coordinate string
    Default: 0

    Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the x axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.

  • xperiodalignment
    Code: fig.update_traces(xperiodalignment=<VALUE>, selector=dict(type='waterfall'))
    Type: enumerated , one of ( "start" | "middle" | "end" )
    Default: "middle"

    Only relevant when the axis `type` is "date". Sets the alignment of data points on the x axis.

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

    Only relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • yperiod
    Code: fig.update_traces(yperiod=<VALUE>, selector=dict(type='waterfall'))
    Type: number or categorical coordinate string
    Default: 0

    Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the y axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.

  • yperiodalignment
    Code: fig.update_traces(yperiodalignment=<VALUE>, selector=dict(type='waterfall'))
    Type: enumerated , one of ( "start" | "middle" | "end" )
    Default: "middle"

    Only relevant when the axis `type` is "date". Sets the alignment of data points on the y axis.

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

    Only relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • textangle
    Code: fig.update_traces(textangle=<VALUE>, selector=dict(type='waterfall'))
    Type: angle
    Default: "auto"

    Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars.

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

    Sets the font used for `text`.

    • color
      Code: fig.update_traces(textfont_color=<VALUE>, selector=dict(type='waterfall'))
      Type: color or array of colors
    • family
      Code: fig.update_traces(textfont_family=<VALUE>, selector=dict(type='waterfall'))
      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".

    • size
      Code: fig.update_traces(textfont_size=<VALUE>, selector=dict(type='waterfall'))
      Type: number or array of numbers greater than or equal to 1
  • textinfo
    Code: fig.update_traces(textinfo=<VALUE>, selector=dict(type='waterfall'))
    Type: flaglist string. Any combination of "label", "text", "initial", "delta", "final" joined with a "+" OR "none".
    Examples: "label", "text", "label+text", "label+text+initial", "none"

    Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace).

  • selectedpoints
    Code: fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='waterfall'))
    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.

  • cliponaxis
    Code: fig.update_traces(cliponaxis=<VALUE>, selector=dict(type='waterfall'))
    Type: boolean
    Default: True

    Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to "below traces".

  • connector
    Code: fig.update_traces(connector=dict(...), selector=dict(type='waterfall'))
    Type: dict containing one or more of the keys listed below.
    • line
      Code: fig.update_traces(connector_line=dict(...), selector=dict(type='waterfall'))
      Type: dict containing one or more of the keys listed below.
      • color
        Code: fig.update_traces(connector_line_color=<VALUE>, selector=dict(type='waterfall'))
        Type: color
        Default: "#444"

        Sets the line color.

      • dash
        Code: fig.update_traces(connector_line_dash=<VALUE>, selector=dict(type='waterfall'))
        Type: string
        Default: "solid"

        Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").

      • width
        Code: fig.update_traces(connector_line_width=<VALUE>, selector=dict(type='waterfall'))
        Type: number greater than or equal to 0
        Default: 2

        Sets the line width (in px).

    • mode
      Code: fig.update_traces(connector_mode=<VALUE>, selector=dict(type='waterfall'))
      Type: enumerated , one of ( "spanning" | "between" )
      Default: "between"

      Sets the shape of connector lines.

    • visible
      Code: fig.update_traces(connector_visible=<VALUE>, selector=dict(type='waterfall'))
      Type: boolean
      Default: True

      Determines if connector lines are drawn.

  • constraintext
    Code: fig.update_traces(constraintext=<VALUE>, selector=dict(type='waterfall'))
    Type: enumerated , one of ( "inside" | "outside" | "both" | "none" )
    Default: "both"

    Constrain the size of text inside or outside a bar to be no larger than the bar itself.

  • increasing
    Code: fig.update_traces(increasing=dict(...), selector=dict(type='waterfall'))
    Type: dict containing one or more of the keys listed below.
    • marker
      Code: fig.update_traces(increasing_marker=dict(...), selector=dict(type='waterfall'))
      Type: dict containing one or more of the keys listed below.
      • color
        Code: fig.update_traces(increasing_marker_color=<VALUE>, selector=dict(type='waterfall'))
        Type: color

        Sets the marker color of all increasing values.

      • line
        Code: fig.update_traces(increasing_marker_line=dict(...), selector=dict(type='waterfall'))
        Type: dict containing one or more of the keys listed below.
        • color
          Code: fig.update_traces(increasing_marker_line_color=<VALUE>, selector=dict(type='waterfall'))
          Type: color

          Sets the line color of all increasing values.

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

          Sets the line width of all increasing values.

  • decreasing
    Code: fig.update_traces(decreasing=dict(...), selector=dict(type='waterfall'))
    Type: dict containing one or more of the keys listed below.
    • marker
      Code: fig.update_traces(decreasing_marker=dict(...), selector=dict(type='waterfall'))
      Type: dict containing one or more of the keys listed below.
      • color
        Code: fig.update_traces(decreasing_marker_color=<VALUE>, selector=dict(type='waterfall'))
        Type: color

        Sets the marker color of all decreasing values.

      • line
        Code: fig.update_traces(decreasing_marker_line=dict(...), selector=dict(type='waterfall'))
        Type: dict containing one or more of the keys listed below.
        • color
          Code: fig.update_traces(decreasing_marker_line_color=<VALUE>, selector=dict(type='waterfall'))
          Type: color

          Sets the line color of all decreasing values.

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

          Sets the line width of all decreasing values.

  • hoverlabel
    Code: fig.update_traces(hoverlabel=dict(...), selector=dict(type='waterfall'))
    Type: dict containing one or more of the keys listed below.
    • align
      Code: fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='waterfall'))
      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='waterfall'))
      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='waterfall'))
      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='waterfall'))
      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='waterfall'))
        Type: color or array of colors
      • family
        Code: fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='waterfall'))
        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".

      • size
        Code: fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='waterfall'))
        Type: number or array of numbers greater than or equal to 1
    • namelength
      Code: fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='waterfall'))
      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.

  • insidetextanchor
    Code: fig.update_traces(insidetextanchor=<VALUE>, selector=dict(type='waterfall'))
    Type: enumerated , one of ( "end" | "middle" | "start" )
    Default: "end"

    Determines if texts are kept at center or start/end points in `textposition` "inside" mode.

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

    Sets the font used for `text` lying inside the bar.

    • color
      Code: fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='waterfall'))
      Type: color or array of colors
    • family
      Code: fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='waterfall'))
      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".

    • size
      Code: fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='waterfall'))
      Type: number or array of numbers greater than or equal to 1
  • outsidetextfont
    Code: fig.update_traces(outsidetextfont=dict(...), selector=dict(type='waterfall'))
    Type: dict containing one or more of the keys listed below.

    Sets the font used for `text` lying outside the bar.

    • color
      Code: fig.update_traces(outsidetextfont_color=<VALUE>, selector=dict(type='waterfall'))
      Type: color or array of colors
    • family
      Code: fig.update_traces(outsidetextfont_family=<VALUE>, selector=dict(type='waterfall'))
      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".

    • size
      Code: fig.update_traces(outsidetextfont_size=<VALUE>, selector=dict(type='waterfall'))
      Type: number or array of numbers greater than or equal to 1
  • totals
    Code: fig.update_traces(totals=dict(...), selector=dict(type='waterfall'))
    Type: dict containing one or more of the keys listed below.
    • marker
      Code: fig.update_traces(totals_marker=dict(...), selector=dict(type='waterfall'))
      Type: dict containing one or more of the keys listed below.
      • color
        Code: fig.update_traces(totals_marker_color=<VALUE>, selector=dict(type='waterfall'))
        Type: color

        Sets the marker color of all intermediate sums and total values.

      • line
        Code: fig.update_traces(totals_marker_line=dict(...), selector=dict(type='waterfall'))
        Type: dict containing one or more of the keys listed below.
        • color
          Code: fig.update_traces(totals_marker_line_color=<VALUE>, selector=dict(type='waterfall'))
          Type: color

          Sets the line color of all intermediate sums and total values.

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

          Sets the line width of all intermediate sums and total values.

  • uirevision
    Code: fig.update_traces(uirevision=<VALUE>, selector=dict(type='waterfall'))
    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.