Black Lives Matter. Please consider donating to Black Girls Code today.

JavaScript Figure Reference: waterfall Traces

A waterfall trace is an object with the key "type" equal to "waterfall" (i.e. {"type": "waterfall"}) and any of the keys 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 th "v" (the default) and the labels are set in `x`. By setting `orientation` to "h", the roles are interchanged.

  • type
    Parent: data[type=waterfall]
    Type: "waterfall"
  • name
    Parent: data[type=waterfall]
    Type: string

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

  • visible
    Parent: data[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
    Parent: data[type=waterfall]
    Type: boolean
    Default: true

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

  • legendgroup
    Parent: data[type=waterfall]
    Type: string
    Default: ""

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

  • opacity
    Parent: data[type=waterfall]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=waterfall]
    Type: data array

    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
    Parent: data[type=waterfall]
    Type: data array

    Sets the x coordinates.

  • x0
    Parent: data[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
    Parent: data[type=waterfall]
    Type: number
    Default: 1

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

  • y
    Parent: data[type=waterfall]
    Type: data array

    Sets the y coordinates.

  • y0
    Parent: data[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
    Parent: data[type=waterfall]
    Type: number
    Default: 1

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

  • base
    Parent: data[type=waterfall]
    Type: number

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

  • width
    Parent: data[type=waterfall]
    Type: number or array of numbers greater than or equal to 0

    Sets the bar width (in position axis units).

  • measure
    Parent: data[type=waterfall]
    Type: data array
    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
    Parent: data[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
    Parent: data[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
    Parent: data[type=waterfall]
    Type: enumerated or array of enumerateds , one of ( "inside" | "outside" | "auto" | "none" )
    Default: "none"

    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.

  • texttemplate
    Parent: data[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-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. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `initial`, `delta`, `final` and `label`.

  • hovertext
    Parent: data[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
    Parent: data[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
    Parent: data[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}". 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 `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>`.

  • meta
    Parent: data[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
    Parent: data[type=waterfall]
    Type: data array

    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
    Parent: data[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
    Parent: data[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
    Parent: data[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
    Parent: data[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
    Parent: data[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.

  • textangle
    Parent: data[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
    Parent: data[type=waterfall]
    Type: object containing one or more of the keys listed below.

    Sets the font used for `text`.

    • family
      Parent: data[type=waterfall].textfont
      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
      Parent: data[type=waterfall].textfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=waterfall].textfont
      Type: color or array of colors
  • textinfo
    Parent: data[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
    Parent: data[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
    Parent: data[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
    Parent: data[type=waterfall]
    Type: object containing one or more of the keys listed below.
    • line
      Parent: data[type=waterfall].connector
      Type: object containing one or more of the keys listed below.
      • color
        Parent: data[type=waterfall].connector.line
        Type: color
        Default: "#444"

        Sets the line color.

      • width
        Parent: data[type=waterfall].connector.line
        Type: number greater than or equal to 0
        Default: 2

        Sets the line width (in px).

      • dash
        Parent: data[type=waterfall].connector.line
        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").

    • mode
      Parent: data[type=waterfall].connector
      Type: enumerated , one of ( "spanning" | "between" )
      Default: "between"

      Sets the shape of connector lines.

    • visible
      Parent: data[type=waterfall].connector
      Type: boolean
      Default: true

      Determines if connector lines are drawn.

  • constraintext
    Parent: data[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
    Parent: data[type=waterfall]
    Type: object containing one or more of the keys listed below.
    • marker
      Parent: data[type=waterfall].increasing
      Type: object containing one or more of the keys listed below.
      • color
        Parent: data[type=waterfall].increasing.marker
        Type: color

        Sets the marker color of all increasing values.

      • line
        Parent: data[type=waterfall].increasing.marker
        Type: object containing one or more of the keys listed below.
        • color
          Parent: data[type=waterfall].increasing.marker.line
          Type: color

          Sets the line color of all increasing values.

        • width
          Parent: data[type=waterfall].increasing.marker.line
          Type: number greater than or equal to 0
          Default: 0

          Sets the line width of all increasing values.

  • decreasing
    Parent: data[type=waterfall]
    Type: object containing one or more of the keys listed below.
    • marker
      Parent: data[type=waterfall].decreasing
      Type: object containing one or more of the keys listed below.
      • color
        Parent: data[type=waterfall].decreasing.marker
        Type: color

        Sets the marker color of all decreasing values.

      • line
        Parent: data[type=waterfall].decreasing.marker
        Type: object containing one or more of the keys listed below.
        • color
          Parent: data[type=waterfall].decreasing.marker.line
          Type: color

          Sets the line color of all decreasing values.

        • width
          Parent: data[type=waterfall].decreasing.marker.line
          Type: number greater than or equal to 0
          Default: 0

          Sets the line width of all decreasing values.

  • hoverlabel
    Parent: data[type=waterfall]
    Type: object containing one or more of the keys listed below.
    • bgcolor
      Parent: data[type=waterfall].hoverlabel
      Type: color or array of colors

      Sets the background color of the hover labels for this trace

    • bordercolor
      Parent: data[type=waterfall].hoverlabel
      Type: color or array of colors

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

    • font
      Parent: data[type=waterfall].hoverlabel
      Type: object containing one or more of the keys listed below.

      Sets the font used in hover labels.

      • family
        Parent: data[type=waterfall].hoverlabel.font
        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
        Parent: data[type=waterfall].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • color
        Parent: data[type=waterfall].hoverlabel.font
        Type: color or array of colors
    • align
      Parent: data[type=waterfall].hoverlabel
      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

    • namelength
      Parent: data[type=waterfall].hoverlabel
      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
    Parent: data[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
    Parent: data[type=waterfall]
    Type: object containing one or more of the keys listed below.

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

    • family
      Parent: data[type=waterfall].insidetextfont
      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
      Parent: data[type=waterfall].insidetextfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=waterfall].insidetextfont
      Type: color or array of colors
  • outsidetextfont
    Parent: data[type=waterfall]
    Type: object containing one or more of the keys listed below.

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

    • family
      Parent: data[type=waterfall].outsidetextfont
      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
      Parent: data[type=waterfall].outsidetextfont
      Type: number or array of numbers greater than or equal to 1
    • color
      Parent: data[type=waterfall].outsidetextfont
      Type: color or array of colors
  • totals
    Parent: data[type=waterfall]
    Type: object containing one or more of the keys listed below.
    • marker
      Parent: data[type=waterfall].totals
      Type: object containing one or more of the keys listed below.
      • color
        Parent: data[type=waterfall].totals.marker
        Type: color

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

      • line
        Parent: data[type=waterfall].totals.marker
        Type: object containing one or more of the keys listed below.
        • color
          Parent: data[type=waterfall].totals.marker.line
          Type: color

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

        • width
          Parent: data[type=waterfall].totals.marker.line
          Type: number greater than or equal to 0
          Default: 0

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

  • uirevision
    Parent: data[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.