plotly.graph_objects.waterfall package

class plotly.graph_objects.waterfall.Connector(arg=None, line=None, mode=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property line

The ‘line’ property is an instance of Line that may be specified as:

Returns

Return type

plotly.graph_objects.waterfall.connector.Line

property mode

Sets the shape of connector lines.

The ‘mode’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘spanning’, ‘between’]

Returns

Return type

Any

property visible

Determines if connector lines are drawn.

The ‘visible’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

class plotly.graph_objects.waterfall.Decreasing(arg=None, marker=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

Returns

Return type

plotly.graph_objects.waterfall.decreasing.Marker

class plotly.graph_objects.waterfall.Hoverlabel(arg=None, align=None, alignsrc=None, bgcolor=None, bgcolorsrc=None, bordercolor=None, bordercolorsrc=None, font=None, namelength=None, namelengthsrc=None, showarrow=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property align

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

The ‘align’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘left’, ‘right’, ‘auto’]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

Any|numpy.ndarray

property alignsrc

Sets the source reference on Chart Studio Cloud for align.

The ‘alignsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property bgcolor

Sets the background color of the hover labels for this trace

The ‘bgcolor’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color: see https://plotly.com/python/css-colors/ for a list

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property bgcolorsrc

Sets the source reference on Chart Studio Cloud for bgcolor.

The ‘bgcolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property bordercolor

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

The ‘bordercolor’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color: see https://plotly.com/python/css-colors/ for a list

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property bordercolorsrc

Sets the source reference on Chart Studio Cloud for bordercolor.

The ‘bordercolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property font

Sets the font used in hover labels.

The ‘font’ property is an instance of Font that may be specified as:

Returns

Return type

plotly.graph_objects.waterfall.hoverlabel.Font

property namelength

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

The ‘namelength’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

int|numpy.ndarray

property namelengthsrc

Sets the source reference on Chart Studio Cloud for namelength.

The ‘namelengthsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property showarrow

Sets whether or not to show the hover label arrow/triangle pointing to the data point.

The ‘showarrow’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

class plotly.graph_objects.waterfall.Increasing(arg=None, marker=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

Returns

Return type

plotly.graph_objects.waterfall.increasing.Marker

class plotly.graph_objects.waterfall.Insidetextfont(arg=None, color=None, colorsrc=None, family=None, familysrc=None, lineposition=None, linepositionsrc=None, shadow=None, shadowsrc=None, size=None, sizesrc=None, style=None, stylesrc=None, textcase=None, textcasesrc=None, variant=None, variantsrc=None, weight=None, weightsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property color
The ‘color’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color: see https://plotly.com/python/css-colors/ for a list

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property colorsrc

Sets the source reference on Chart Studio Cloud for color.

The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property family

HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren’t available.

The ‘family’ property is a string and must be specified as:

  • A non-empty string

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

str|numpy.ndarray

property familysrc

Sets the source reference on Chart Studio Cloud for family.

The ‘familysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property lineposition

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.

The ‘lineposition’ property is a flaglist and may be specified as a string containing:

  • Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)

  • A list or array of the above

Returns

Return type

Any|numpy.ndarray

property linepositionsrc

Sets the source reference on Chart Studio Cloud for lineposition.

The ‘linepositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property shadow

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.

The ‘shadow’ property is a string and must be specified as:

  • A string

  • A number that will be converted to a string

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

str|numpy.ndarray

property shadowsrc

Sets the source reference on Chart Studio Cloud for shadow.

The ‘shadowsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property size
The ‘size’ property is a number and may be specified as:

  • An int or float in the interval [1, inf]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

int|float|numpy.ndarray

property sizesrc

Sets the source reference on Chart Studio Cloud for size.

The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property style

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

The ‘style’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘normal’, ‘italic’]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

Any|numpy.ndarray

property stylesrc

Sets the source reference on Chart Studio Cloud for style.

The ‘stylesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property textcase

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

The ‘textcase’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘normal’, ‘word caps’, ‘upper’, ‘lower’]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

Any|numpy.ndarray

property textcasesrc

Sets the source reference on Chart Studio Cloud for textcase.

The ‘textcasesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property variant

Sets the variant of the font.

The ‘variant’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

Any|numpy.ndarray

property variantsrc

Sets the source reference on Chart Studio Cloud for variant.

The ‘variantsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property weight

Sets the weight (or boldness) of the font.

The ‘weight’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

int|numpy.ndarray

property weightsrc

Sets the source reference on Chart Studio Cloud for weight.

The ‘weightsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

class plotly.graph_objects.waterfall.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property font

Sets this legend group’s title font.

The ‘font’ property is an instance of Font that may be specified as:

Returns

Return type

plotly.graph_objects.waterfall.legendgrouptitle.Font

property text

Sets the title of the legend group.

The ‘text’ property is a string and must be specified as:

  • A string

  • A number that will be converted to a string

Returns

Return type

str

class plotly.graph_objects.waterfall.Outsidetextfont(arg=None, color=None, colorsrc=None, family=None, familysrc=None, lineposition=None, linepositionsrc=None, shadow=None, shadowsrc=None, size=None, sizesrc=None, style=None, stylesrc=None, textcase=None, textcasesrc=None, variant=None, variantsrc=None, weight=None, weightsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property color
The ‘color’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color: see https://plotly.com/python/css-colors/ for a list

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property colorsrc

Sets the source reference on Chart Studio Cloud for color.

The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property family

HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren’t available.

The ‘family’ property is a string and must be specified as:

  • A non-empty string

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

str|numpy.ndarray

property familysrc

Sets the source reference on Chart Studio Cloud for family.

The ‘familysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property lineposition

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.

The ‘lineposition’ property is a flaglist and may be specified as a string containing:

  • Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)

  • A list or array of the above

Returns

Return type

Any|numpy.ndarray

property linepositionsrc

Sets the source reference on Chart Studio Cloud for lineposition.

The ‘linepositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property shadow

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.

The ‘shadow’ property is a string and must be specified as:

  • A string

  • A number that will be converted to a string

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

str|numpy.ndarray

property shadowsrc

Sets the source reference on Chart Studio Cloud for shadow.

The ‘shadowsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property size
The ‘size’ property is a number and may be specified as:

  • An int or float in the interval [1, inf]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

int|float|numpy.ndarray

property sizesrc

Sets the source reference on Chart Studio Cloud for size.

The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property style

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

The ‘style’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘normal’, ‘italic’]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

Any|numpy.ndarray

property stylesrc

Sets the source reference on Chart Studio Cloud for style.

The ‘stylesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property textcase

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

The ‘textcase’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘normal’, ‘word caps’, ‘upper’, ‘lower’]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

Any|numpy.ndarray

property textcasesrc

Sets the source reference on Chart Studio Cloud for textcase.

The ‘textcasesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property variant

Sets the variant of the font.

The ‘variant’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

Any|numpy.ndarray

property variantsrc

Sets the source reference on Chart Studio Cloud for variant.

The ‘variantsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property weight

Sets the weight (or boldness) of the font.

The ‘weight’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

int|numpy.ndarray

property weightsrc

Sets the source reference on Chart Studio Cloud for weight.

The ‘weightsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

class plotly.graph_objects.waterfall.Stream(arg=None, maxpoints=None, token=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property maxpoints

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

The ‘maxpoints’ property is a number and may be specified as:

  • An int or float in the interval [0, 10000]

Returns

Return type

int|float

property token

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

The ‘token’ property is a string and must be specified as:

  • A non-empty string

Returns

Return type

str

class plotly.graph_objects.waterfall.Textfont(arg=None, color=None, colorsrc=None, family=None, familysrc=None, lineposition=None, linepositionsrc=None, shadow=None, shadowsrc=None, size=None, sizesrc=None, style=None, stylesrc=None, textcase=None, textcasesrc=None, variant=None, variantsrc=None, weight=None, weightsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property color
The ‘color’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color: see https://plotly.com/python/css-colors/ for a list

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property colorsrc

Sets the source reference on Chart Studio Cloud for color.

The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property family

HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren’t available.

The ‘family’ property is a string and must be specified as:

  • A non-empty string

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

str|numpy.ndarray

property familysrc

Sets the source reference on Chart Studio Cloud for family.

The ‘familysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property lineposition

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.

The ‘lineposition’ property is a flaglist and may be specified as a string containing:

  • Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)

  • A list or array of the above

Returns

Return type

Any|numpy.ndarray

property linepositionsrc

Sets the source reference on Chart Studio Cloud for lineposition.

The ‘linepositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property shadow

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.

The ‘shadow’ property is a string and must be specified as:

  • A string

  • A number that will be converted to a string

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

str|numpy.ndarray

property shadowsrc

Sets the source reference on Chart Studio Cloud for shadow.

The ‘shadowsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property size
The ‘size’ property is a number and may be specified as:

  • An int or float in the interval [1, inf]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

int|float|numpy.ndarray

property sizesrc

Sets the source reference on Chart Studio Cloud for size.

The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property style

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

The ‘style’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘normal’, ‘italic’]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

Any|numpy.ndarray

property stylesrc

Sets the source reference on Chart Studio Cloud for style.

The ‘stylesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property textcase

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

The ‘textcase’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘normal’, ‘word caps’, ‘upper’, ‘lower’]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

Any|numpy.ndarray

property textcasesrc

Sets the source reference on Chart Studio Cloud for textcase.

The ‘textcasesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property variant

Sets the variant of the font.

The ‘variant’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

Any|numpy.ndarray

property variantsrc

Sets the source reference on Chart Studio Cloud for variant.

The ‘variantsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property weight

Sets the weight (or boldness) of the font.

The ‘weight’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

int|numpy.ndarray

property weightsrc

Sets the source reference on Chart Studio Cloud for weight.

The ‘weightsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

class plotly.graph_objects.waterfall.Totals(arg=None, marker=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

Returns

Return type

plotly.graph_objects.waterfall.totals.Marker