GeezerVison is showing plotly.com — plotly.graph_objects.histogram package — 7.1.0 documentation
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 is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
class
plotly.graph_objects.histogram.ErrorX(arg=None, array=None, arrayminus=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
color¶
Sets the stroke color of the error bars.
- 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/
- Returns
-
- Return type
str
-
property
copy_ystyle¶
- The ‘copy_ystyle’ property is a boolean and must be specified as:
-
- 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 is a boolean and must be specified as:
-
- 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:
-
- Returns
-
- Return type
int|float
-
property
traceref¶
- The ‘traceref’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
tracerefminus¶
- The ‘tracerefminus’ property is an integer and may be specified as:
-
- 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:
-
- 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:
-
- Returns
-
- Return type
int|float
-
property
visible¶
Determines whether or not this set of error bars is visible.
- The ‘visible’ property is a boolean and must be specified as:
-
- 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:
-
- Returns
-
- Return type
int|float
-
class
plotly.graph_objects.histogram.ErrorY(arg=None, array=None, arrayminus=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
color¶
Sets the stroke color of the error bars.
- 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/
- 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 is a boolean and must be specified as:
-
- 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:
-
- Returns
-
- Return type
int|float
-
property
traceref¶
- The ‘traceref’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
tracerefminus¶
- The ‘tracerefminus’ property is an integer and may be specified as:
-
- 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:
-
- 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:
-
- Returns
-
- Return type
int|float
-
property
visible¶
Determines whether or not this set of error bars is visible.
- The ‘visible’ property is a boolean and must be specified as:
-
- 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:
-
- Returns
-
- Return type
int|float
-
class
plotly.graph_objects.histogram.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:
-
- 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:
- 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 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:
-
- Returns
-
- Return type
bool
-
class
plotly.graph_objects.histogram.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/
- 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:
-
- 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:
- Returns
-
- Return type
Any
-
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:
-
- Returns
-
- Return type
str
-
property
size¶
- The ‘size’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
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’]
- Returns
-
- Return type
Any
-
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’]
- Returns
-
- Return type
Any
-
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’]
- Returns
-
- Return type
Any
-
property
weight¶
Sets the weight (or boldness) of the font.
- The ‘weight’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
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:
- 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:
-
- 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, cornerradius=None, line=None, opacity=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 is a boolean and must be specified as:
-
- 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 is a boolean and must be specified as:
-
- 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:
-
- 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:
-
- 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:
-
- Returns
-
- Return type
int|float
-
property
color¶
Sets the marker color. 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 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 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:
- 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, hsla, hwb, 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
cornerradius¶
Sets the rounding of corners. May be an integer number of
pixels, or a percentage of bar width (as a string ending in %).
Defaults to layout.barcornerradius. In stack or relative
barmode, the first trace to set cornerradius is used for the
whole stack.
The ‘cornerradius’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
line¶
The ‘line’ property is an instance of Line
that may be specified as:
- 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
pattern¶
Sets the pattern within the marker.
The ‘pattern’ property is an instance of Pattern
that may be specified as:
- 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 is a boolean and must be specified as:
-
- 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 is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
class
plotly.graph_objects.histogram.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/
- 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:
-
- 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:
- Returns
-
- Return type
Any
-
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:
-
- Returns
-
- Return type
str
-
property
size¶
- The ‘size’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
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’]
- Returns
-
- Return type
Any
-
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’]
- Returns
-
- Return type
Any
-
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’]
- Returns
-
- Return type
Any
-
property
weight¶
Sets the weight (or boldness) of the font.
- The ‘weight’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
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:
- Returns
-
- Return type
plotly.graph_objects.histogram.selected.Marker
-
property
textfont¶
The ‘textfont’ property is an instance of Textfont
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.histogram.selected.Textfont
-
class
plotly.graph_objects.histogram.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/
- 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:
-
- 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:
- Returns
-
- Return type
Any
-
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:
-
- Returns
-
- Return type
str
-
property
size¶
- The ‘size’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
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’]
- Returns
-
- Return type
Any
-
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’]
- Returns
-
- Return type
Any
-
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’]
- Returns
-
- Return type
Any
-
property
weight¶
Sets the weight (or boldness) of the font.
- The ‘weight’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
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:
- Returns
-
- Return type
plotly.graph_objects.histogram.unselected.Marker
-
property
textfont¶
The ‘textfont’ property is an instance of Textfont
that may be specified as:
- 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
|
