plotly.graph_objects.histogram package¶

class plotly.graph_objects.histogram.Cumulative(arg=None, currentbin=None, direction=None, enabled=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property currentbin¶

Only applies if cumulative is enabled. Sets whether the current bin is included, excluded, or has half of its value included in the current cumulative value. “include” is the default for compatibility with various other tools, however it introduces a half-bin bias to the results. “exclude” makes the opposite half-bin bias, and “half” removes it.

The ‘currentbin’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘include’, ‘exclude’, ‘half’]

Returns
Return type: Any

property direction¶

Only applies if cumulative is enabled. If “increasing” (default) we sum all prior bins, so the result increases from left to right. If “decreasing” we sum later bins so the result decreases from left to right.

The ‘direction’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘increasing’, ‘decreasing’]

Returns
Return type: Any

property enabled¶

If true, display the cumulative distribution by summing the binned values. Use the direction and centralbin attributes to tune the accumulation method. Note: in this mode, the “density” histnorm settings behave the same as their equivalents without “density”: “” and “density” both rise to the number of data points, and “probability” and probability density both rise to the number of sample points.

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

Returns
Return type: bool

class plotly.graph_objects.histogram.ErrorX(arg=None, array=None, arrayminus=None, arrayminussrc=None, arraysrc=None, color=None, copy_ystyle=None, symmetric=None, thickness=None, traceref=None, tracerefminus=None, type=None, value=None, valueminus=None, visible=None, width=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property array¶

Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

The ‘array’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property arrayminus¶

Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

The ‘arrayminus’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property arrayminussrc¶

Sets the source reference on Chart Studio Cloud for arrayminus.

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

Returns
Return type: str

property arraysrc¶

Sets the source reference on Chart Studio Cloud for array.

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

Returns
Return type: str

property color¶

Sets the stoke color of the error bars.

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:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property copy_ystyle¶

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

Returns
Return type: bool

property symmetric¶

Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

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

Returns
Return type: bool

property thickness¶

Sets the thickness (in px) of the error bars.

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

An int or float in the interval [0, inf]

Returns
Return type: int|float

property traceref¶

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

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

Returns
Return type: int

property tracerefminus¶

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

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

Returns
Return type: int

property type¶

Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in value. If “percent”, the bar lengths correspond to a percentage of underlying data. Set this percentage in value. If “sqrt”, the bar lengths correspond to the square of the underlying data. If “data”, the bar lengths are set with data set array.

The ‘type’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘percent’, ‘constant’, ‘sqrt’, ‘data’]

Returns
Return type: Any

property value¶

Sets the value of either the percentage (if type is set to “percent”) or the constant (if type is set to “constant”) corresponding to the lengths of the error bars.

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

An int or float in the interval [0, inf]

Returns
Return type: int|float

property valueminus¶

Sets the value of either the percentage (if type is set to “percent”) or the constant (if type is set to “constant”) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

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

An int or float in the interval [0, inf]

Returns
Return type: int|float

property visible¶

Determines whether or not this set of error bars is visible.

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

Returns
Return type: bool

property width¶

Sets the width (in px) of the cross-bar at both ends of the error bars.

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

An int or float in the interval [0, inf]

Returns
Return type: int|float

class plotly.graph_objects.histogram.ErrorY(arg=None, array=None, arrayminus=None, arrayminussrc=None, arraysrc=None, color=None, symmetric=None, thickness=None, traceref=None, tracerefminus=None, type=None, value=None, valueminus=None, visible=None, width=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property array¶

Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

The ‘array’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property arrayminus¶

Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

The ‘arrayminus’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property arrayminussrc¶

Sets the source reference on Chart Studio Cloud for arrayminus.

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

Returns
Return type: str

property arraysrc¶

Sets the source reference on Chart Studio Cloud for array.

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

Returns
Return type: str

property color¶

Sets the stoke color of the error bars.

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:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property symmetric¶

Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

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

Returns
Return type: bool

property thickness¶

Sets the thickness (in px) of the error bars.

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

An int or float in the interval [0, inf]

Returns
Return type: int|float

property traceref¶

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

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

Returns
Return type: int

property tracerefminus¶

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

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

Returns
Return type: int

property type¶

The ‘type’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘percent’, ‘constant’, ‘sqrt’, ‘data’]

Returns
Return type: Any

property value¶

Sets the value of either the percentage (if type is set to “percent”) or the constant (if type is set to “constant”) corresponding to the lengths of the error bars.

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

An int or float in the interval [0, inf]

Returns
Return type: int|float

property valueminus¶

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

An int or float in the interval [0, inf]

Returns
Return type: int|float

property visible¶

Determines whether or not this set of error bars is visible.

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

Returns
Return type: bool

property width¶

Sets the width (in px) of the cross-bar at both ends of the error bars.

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

An int or float in the interval [0, inf]

Returns
Return type: int|float

class plotly.graph_objects.histogram.Hoverlabel(arg=None, align=None, alignsrc=None, bgcolor=None, bgcolorsrc=None, bordercolor=None, bordercolorsrc=None, font=None, namelength=None, namelengthsrc=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:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
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:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
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:

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

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

Supported dict properties:

color

colorsrc
Sets the source reference on Chart Studio Cloud for color.

family
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”.

familysrc
Sets the source reference on Chart Studio Cloud for family.

size

sizesrc
Sets the source reference on Chart Studio Cloud for size.

Returns
Return type: plotly.graph_objects.histogram.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

class plotly.graph_objects.histogram.Insidetextfont(arg=None, color=None, family=None, size=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:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property family¶

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

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

A non-empty string

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]

Returns
Return type: int|float

class plotly.graph_objects.histogram.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.histogram.legendgrouptitle.Font

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

Supported dict properties:

color

family
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

Returns
Return type: plotly.graph_objects.histogram.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.histogram.Marker(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, colorsrc=None, line=None, opacity=None, opacitysrc=None, pattern=None, reversescale=None, showscale=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property autocolorscale¶

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color`is set to a numerical array. In case `colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

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

Returns
Return type: bool

property cauto¶

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color`is set to a numerical array. Defaults to `false when marker.cmin and marker.cmax are set by the user.

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

Returns
Return type: bool

property cmax¶

Sets the upper bound of the color domain. Has an effect only if in marker.color`is set to a numerical array. Value should have the same units as in `marker.color and if set, marker.cmin must be set as well.

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

An int or float

Returns
Return type: int|float

property cmid¶

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color`is set to a numerical array. Value should have the same units as in `marker.color. Has no effect when marker.cauto is false.

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

An int or float

Returns
Return type: int|float

property cmin¶

Sets the lower bound of the color domain. Has an effect only if in marker.color`is set to a numerical array. Value should have the same units as in `marker.color and if set, marker.cmax must be set as well.

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

An int or float

Returns
Return type: int|float

property color¶

Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

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:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A number that will be interpreted as a color according to histogram.marker.colorscale
A list or array of any of the above

Returns
Return type: str|numpy.ndarray

property coloraxis¶

Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)

Returns
Return type: str

property colorbar¶

The ‘colorbar’ property is an instance of ColorBar that may be specified as:

An instance of plotly.graph_objects.histogram.marker.ColorBar

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

Supported dict properties:

bgcolor
Sets the color of padded area.

bordercolor
Sets the axis line color.

borderwidth
Sets the width (in px) or the border enclosing this color bar.

dtick
Sets the step in-between ticks on this axis. Use with tick0. Must be a positive number, or special strings available to “log” and “date” axes. If the axis type is “log”, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, … set dtick to 1. To set tick marks at 1, 100, 10000, … set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to log_10(5), or 0.69897000433. “log” has several special values; “L<f>”, where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 0.1, dtick = “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use “D1” (all digits) or “D2” (only 2 and 5). tick0 is ignored for “D1” and “D2”. If the axis type is “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months. n must be a positive integer. To set ticks on the 15th of every third month, set tick0 to “2000-01-15” and dtick to “M3”. To set ticks every 4 years, set dtick to “M48”

exponentformat
Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If “none”, it appears as 1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If “power”, 1x10^9 (with 9 in a super script). If “SI”, 1G. If “B”, 1B.

len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use len to set the value.

minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is “SI” or “B”.

nticks
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to nticks. Has an effect only if tickmode is set to “auto”.

orientation
Sets the orientation of the colorbar.

outlinecolor
Sets the axis line color.

outlinewidth
Sets the width (in px) of the axis line.

separatethousands
If “true”, even 4-digit integers are separated

showexponent
If “all”, all exponents are shown besides their significands. If “first”, only the exponent of the first tick is shown. If “last”, only the exponent of the last tick is shown. If “none”, no exponents appear.

showticklabels
Determines whether or not the tick labels are drawn.

showtickprefix
If “all”, all tick labels are displayed with a prefix. If “first”, only the first tick is displayed with a prefix. If “last”, only the last tick is displayed with a suffix. If “none”, tick prefixes are hidden.

showticksuffix
Same as showtickprefix but for tick suffixes.

thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use thickness to set the value.

tick0
Sets the placement of the first tick on this axis. Use with dtick. If the axis type is “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2) except when dtick`=*L<f>* (see `dtick for more info). If the axis type is “date”, it should be a date string, like date data. If the axis type is “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

tickcolor
Sets the tick color.

tickfont
Sets the color bar’s tick label font

tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://github.com/d3/d3-format/tree/v1.4.5#d3-f ormat. 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”

tickformatstops
A tuple of plotly.graph_objects.histogr am.marker.colorbar.Tickformatstop instances or dicts with compatible properties

tickformatstopdefaults
When used in a template (as layout.template.dat a.histogram.marker.colorbar.tickformatstopdefau lts), sets the default property values to use for elements of histogram.marker.colorbar.tickformatstops

ticklabeloverflow
Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is “h”, top and bottom when orientation is “v”.

ticklen
Sets the tick length (in px).

tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via nticks. If “linear”, the placement of the ticks is determined by a starting position tick0 and a tick step dtick (“linear” is the default value if tick0 and dtick are provided). If “array”, the placement of the ticks is set via tickvals and the tick text is ticktext. (“array” is the default value if tickvals is provided).

tickprefix
Sets a tick label prefix.

ticks
Determines whether ticks are drawn or not. If “”, this axis’ ticks are not drawn. If “outside” (“inside”), this axis’ are drawn outside (inside) the axis lines.

ticksuffix
Sets a tick label suffix.

ticktext
Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to “array”. Used with tickvals.

ticktextsrc
Sets the source reference on Chart Studio Cloud for ticktext.

tickvals
Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to “array”. Used with ticktext.

tickvalssrc
Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth
Sets the tick width (in px).

title
plotly.graph_objects.histogram.marker.c olorbar.Title instance or dict with compatible properties

titlefont
Deprecated: Please use histogram.marker.colorbar.title.font instead. Sets this color bar’s title font. Note that the title’s font used to be set by the now deprecated titlefont attribute.

titleside
Deprecated: Please use histogram.marker.colorbar.title.side instead. Determines the location of color bar’s title with respect to the color bar. Defaults to “top” when orientation if “v” and defaults to “right” when orientation if “h”. Note that the title’s location used to be set by the now deprecated titleside attribute.

x
Sets the x position of the color bar (in plot fraction). Defaults to 1.02 when orientation is “v” and 0.5 when orientation is “h”.

xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the x position to the “left”, “center” or “right” of the color bar. Defaults to “left” when orientation is “v” and “center” when orientation is “h”.

xpad
Sets the amount of padding (in px) along the x direction.

y
Sets the y position of the color bar (in plot fraction). Defaults to 0.5 when orientation is “v” and 1.02 when orientation is “h”.

yanchor
Sets this color bar’s vertical position anchor This anchor binds the y position to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” when orientation is “v” and “bottom” when orientation is “h”.

ypad
Sets the amount of padding (in px) along the y direction.

Returns
Return type: plotly.graph_objects.histogram.marker.ColorBar

property colorscale¶

Sets the colorscale. Has an effect only if in marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use`marker.cmin` and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,B luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

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

A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

One of the following named colorscales:

[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

Appending ‘_r’ to a named colorscale reverses it.

Returns
Return type: str

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

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

An instance of plotly.graph_objects.histogram.marker.Line

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

Supported dict properties:

autocolorscale
Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color`is set to a numerical array. In case `colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto
Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color`is set to a numerical array. Defaults to `false when marker.line.cmin and marker.line.cmax are set by the user.

cmax
Sets the upper bound of the color domain. Has an effect only if in marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color and if set, marker.line.cmin must be set as well.

cmid
Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color. Has no effect when marker.line.cauto is false.

cmin
Sets the lower bound of the color domain. Has an effect only if in marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color and if set, marker.line.cmax must be set as well.

color
Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale
Sets the colorscale. Has an effect only if in marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use`marker.line.cmin` and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Ele ctric,Greens,Greys,Hot,Jet,Picnic,Portland,Rain bow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc
Sets the source reference on Chart Studio Cloud for color.

reversescale
Reverses the color mapping if true. Has an effect only if in marker.line.color`is set to a numerical array. If true, `marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width
Sets the width (in px) of the lines bounding the marker points.

widthsrc
Sets the source reference on Chart Studio Cloud for width.

Returns
Return type: plotly.graph_objects.histogram.marker.Line

property opacity¶

Sets the opacity of the bars.

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

An int or float in the interval [0, 1]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: int|float|numpy.ndarray

property opacitysrc¶

Sets the source reference on Chart Studio Cloud for opacity.

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

Returns
Return type: str

property pattern¶

Sets the pattern within the marker.

The ‘pattern’ property is an instance of Pattern that may be specified as:

An instance of plotly.graph_objects.histogram.marker.Pattern

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

Supported dict properties:

bgcolor
When there is no colorscale sets the color of background pattern fill. Defaults to a marker.color background when fillmode is “overlay”. Otherwise, defaults to a transparent background.

bgcolorsrc
Sets the source reference on Chart Studio Cloud for bgcolor.

fgcolor
When there is no colorscale sets the color of foreground pattern fill. Defaults to a marker.color background when fillmode is “replace”. Otherwise, defaults to dark grey or white to increase contrast with the bgcolor.

fgcolorsrc
Sets the source reference on Chart Studio Cloud for fgcolor.

fgopacity
Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when fillmode is “overlay”. Otherwise, defaults to 1.

fillmode
Determines whether marker.color should be used as a default to bgcolor or a fgcolor.

shape
Sets the shape of the pattern fill. By default, no pattern is used for filling the area.

shapesrc
Sets the source reference on Chart Studio Cloud for shape.

size
Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.

sizesrc
Sets the source reference on Chart Studio Cloud for size.

solidity
Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.

soliditysrc
Sets the source reference on Chart Studio Cloud for solidity.

Returns
Return type: plotly.graph_objects.histogram.marker.Pattern

property reversescale¶

Reverses the color mapping if true. Has an effect only if in marker.color`is set to a numerical array. If true, `marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

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

Returns
Return type: bool

property showscale¶

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

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

Returns
Return type: bool

class plotly.graph_objects.histogram.Outsidetextfont(arg=None, color=None, family=None, size=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:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property family¶

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

A non-empty string

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]

Returns
Return type: int|float

class plotly.graph_objects.histogram.Selected(arg=None, marker=None, textfont=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.histogram.selected.Marker

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

Supported dict properties:

color
Sets the marker color of selected points.

opacity
Sets the marker opacity of selected points.

Returns
Return type: plotly.graph_objects.histogram.selected.Marker

property textfont¶

The ‘textfont’ property is an instance of Textfont that may be specified as:

An instance of plotly.graph_objects.histogram.selected.Textfont

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

Supported dict properties:

color
Sets the text font color of selected points.

Returns
Return type: plotly.graph_objects.histogram.selected.Textfont

class plotly.graph_objects.histogram.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.histogram.Textfont(arg=None, color=None, family=None, size=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:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property family¶

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

A non-empty string

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]

Returns
Return type: int|float

class plotly.graph_objects.histogram.Unselected(arg=None, marker=None, textfont=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.histogram.unselected.Marker

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

Supported dict properties:

color
Sets the marker color of unselected points, applied only when a selection exists.

opacity
Sets the marker opacity of unselected points, applied only when a selection exists.

Returns
Return type: plotly.graph_objects.histogram.unselected.Marker

property textfont¶

The ‘textfont’ property is an instance of Textfont that may be specified as:

An instance of plotly.graph_objects.histogram.unselected.Textfont

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

Supported dict properties:

color
Sets the text font color of unselected points, applied only when a selection exists.

Returns
Return type: plotly.graph_objects.histogram.unselected.Textfont

class plotly.graph_objects.histogram.XBins(arg=None, end=None, size=None, start=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property end¶

Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by size from start until we reach or exceed end. Defaults to the maximum data value. Like start, for dates use a date string, and for category data end is based on the category serial numbers.

The ‘end’ property accepts values of any type

Returns
Return type: Any

property size¶

If nbinsx is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If nbinsx is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or “M<n>” for months, as in axis.dtick. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit size is used and all others discarded. If no size is provided,the sample data from all traces is combined to determine size as described above.

The ‘size’ property accepts values of any type

Returns
Return type: Any
Type: Sets the size of each x axis bin. Default behavior

property start¶

Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a size of 5 would have a default start of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and start should be a date string. For category data, start is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit start is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.

The ‘start’ property accepts values of any type

Returns
Return type: Any

class plotly.graph_objects.histogram.YBins(arg=None, end=None, size=None, start=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property end¶

Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by size from start until we reach or exceed end. Defaults to the maximum data value. Like start, for dates use a date string, and for category data end is based on the category serial numbers.

The ‘end’ property accepts values of any type

Returns
Return type: Any

property size¶

If nbinsy is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If nbinsy is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or “M<n>” for months, as in axis.dtick. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit size is used and all others discarded. If no size is provided,the sample data from all traces is combined to determine size as described above.

The ‘size’ property accepts values of any type

Returns
Return type: Any
Type: Sets the size of each y axis bin. Default behavior

property start¶

Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a size of 5 would have a default start of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and start should be a date string. For category data, start is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit start is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.

The ‘start’ property accepts values of any type

Returns
Return type: Any

plotly.graph_objects.histogram package¶

Subpackages¶