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:

An instance of plotly.graph_objects.waterfall.connector.Line

A dict of string/value properties that will be passed to the Line constructor

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 is a boolean and must be specified as:

A boolean value: 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:

An instance of plotly.graph_objects.waterfall.decreasing.Marker

A dict of string/value properties that will be passed to the Marker constructor

Returns
Return type: plotly.graph_objects.waterfall.decreasing.Marker

class plotly.graph_objects.waterfall.Hoverlabel(arg=None, align=None, bgcolor=None, bordercolor=None, font=None, namelength=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 bgcolor¶

Sets the background color of the hover labels for this trace

The ‘bgcolor’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
A list or array of any of the above

Returns
Return type: str|numpy.ndarray

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 string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
A list or array of any of the above

Returns
Return type: str|numpy.ndarray

property font¶

Sets the font used in hover labels.

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

An instance of plotly.graph_objects.waterfall.hoverlabel.Font

A dict of string/value properties that will be passed to the Font constructor

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 an 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 showarrow¶

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

The ‘showarrow’ property is a boolean and must be specified as:

A boolean value: 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:

An instance of plotly.graph_objects.waterfall.increasing.Marker

A dict of string/value properties that will be passed to the Marker constructor

Returns
Return type: plotly.graph_objects.waterfall.increasing.Marker

class plotly.graph_objects.waterfall.Insidetextfont(arg=None, color=None, family=None, lineposition=None, shadow=None, size=None, style=None, textcase=None, variant=None, weight=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property color¶

The ‘color’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
A list or array of any of the above

Returns
Return type: str|numpy.ndarray

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 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 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 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 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 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 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 weight¶

Sets the weight (or boldness) of the font.

The ‘weight’ property is an 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

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:

An instance of plotly.graph_objects.waterfall.legendgrouptitle.Font

A dict of string/value properties that will be passed to the Font constructor

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, family=None, lineposition=None, shadow=None, size=None, style=None, textcase=None, variant=None, weight=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property color¶

The ‘color’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
A list or array of any of the above

Returns
Return type: str|numpy.ndarray

property family¶

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 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 shadow¶

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 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 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 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 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 weight¶

Sets the weight (or boldness) of the font.

The ‘weight’ property is an 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

class plotly.graph_objects.waterfall.Textfont(arg=None, color=None, family=None, lineposition=None, shadow=None, size=None, style=None, textcase=None, variant=None, weight=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property color¶

The ‘color’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
A list or array of any of the above

Returns
Return type: str|numpy.ndarray

property family¶

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 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 shadow¶

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 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 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 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 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 weight¶

Sets the weight (or boldness) of the font.

The ‘weight’ property is an 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

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:

An instance of plotly.graph_objects.waterfall.totals.Marker

A dict of string/value properties that will be passed to the Marker constructor

Returns
Return type: plotly.graph_objects.waterfall.totals.Marker

plotly.graph_objects.waterfall package¶

Subpackages¶