plotly.graph_objects.Histogram¶plotly.graph_objects.Histogram(arg=None, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)¶__init__(arg=None, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)¶Construct a new Histogram object
The sample data from which statistics are computed is set in
x for vertically spanning histograms and in y for
horizontally spanning histograms. Binning options are set
xbins and ybins respectively if no aggregation data is
provided.
arg – dict of properties compatible with this constructor or
an instance of plotly.graph_objects.Histogram
alignmentgroup – Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
autobinx – Obsolete: since v1.42 each bin attribute is auto-
determined separately and autobinx is not needed.
However, we accept autobinx: true or false and will
update xbins accordingly before deleting autobinx
from the trace.
autobiny – Obsolete: since v1.42 each bin attribute is auto-
determined separately and autobiny is not needed.
However, we accept autobiny: true or false and will
update ybins accordingly before deleting autobiny
from the trace.
bingroup – Set a group of histogram traces which will have
compatible bin settings. Note that traces on the same
subplot and with the same “orientation” under barmode
“stack”, “relative” and “group” are forced into the
same bingroup, Using bingroup, traces under barmode
“overlay” and on different axes (of the same axis type)
can have compatible bin settings. Note that histogram
and histogram2d* trace can share the same bingroup
cliponaxis – Determines whether the text nodes are clipped about the
subplot axes. To show the text nodes above axis lines
and tick labels, make sure to set xaxis.layer and
yaxis.layer to below traces.
constraintext – Constrain the size of text inside or outside a bar to be no larger than the bar itself.
cumulative – plotly.graph_objects.histogram.Cumulative
instance or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
error_x – plotly.graph_objects.histogram.ErrorX instance
or dict with compatible properties
error_y – plotly.graph_objects.histogram.ErrorY instance
or dict with compatible properties
histfunc – Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
histnorm – Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.histogram.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variable binNumber Anything contained in tag
<extra> is displayed in the secondary box, for
example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag
<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
insidetextanchor – Determines if texts are kept at center or start/end
points in textposition “inside” mode.
insidetextfont – Sets the font used for text lying inside the bar.
legend – Sets the reference to a legend to show this trace in.
References to these legends are “legend”, “legend2”,
“legend3”, etc. Settings for these legends are set in
the layout, under layout.legend, layout.legend2,
etc.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – :class:`plotly.graph_objects.histogram.Legendgrouptitle ` instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. Items and groups
with smaller ranks are presented on top/left side while
with “reversed” legend.traceorder they are on
bottom/right side. The default legendrank is 1000, so
that you can use ranks less than 1000 to place certain
items before all unranked items, and ranks greater than
1000 to go after all unranked items. When having
unranked or equal rank items shapes would be displayed
after traces i.e. according to their order in data and
layout.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
marker – plotly.graph_objects.histogram.Marker instance
or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
nbinsx – Specifies the maximum number of desired bins. This
value will be used in an algorithm that will decide the
optimal bin size such that the histogram best
visualizes the distribution of the data. Ignored if
xbins.size is provided.
nbinsy – Specifies the maximum number of desired bins. This
value will be used in an algorithm that will decide the
optimal bin size such that the histogram best
visualizes the distribution of the data. Ignored if
ybins.size is provided.
offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the bars. With “v” (“h”), the value of the each bar spans along the vertical (horizontal).
outsidetextfont – Sets the font used for text lying outside the bar.
selected – plotly.graph_objects.histogram.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.histogram.Stream instance
or dict with compatible properties
text – Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace’s coordinates.
textangle – Sets the angle of the tick labels with respect to the
bar. For example, a tickangle of -90 draws the tick
labels vertically. With “auto” the texts may
automatically be rotated to fit with the maximum size
in bars.
textfont – Sets the text font.
textposition – Specifies the location of the text. “inside”
positions text inside, next to the bar end (rotated
and scaled if needed). “outside” positions text
outside, next to the bar end (scaled if needed), unless
there is another bar stacked on this one, then the text
gets pushed inside. “auto” tries to position text
inside the bar, but if the bar is too small and no bar
is stacked on this one the text is moved outside. If
“none”, no text appears.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables label and value.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.histogram.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – Sets the sample data to be binned on the x axis.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xbins – plotly.graph_objects.histogram.XBins instance
or dict with compatible properties
xcalendar – Sets the calendar system to use with x date data.
xhoverformat – Sets the hover text formatting rulefor x using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see:
https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
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*By default the values are
formatted using xaxis.hoverformat.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the sample data to be binned on the y axis.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
ybins – plotly.graph_objects.histogram.YBins instance
or dict with compatible properties
ycalendar – Sets the calendar system to use with y date data.
yhoverformat – Sets the hover text formatting rulefor y using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see:
https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
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*By default the values are
formatted using yaxis.hoverformat.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
plotly.graph_objects.histogram¶plotly.graph_objects.histogram.Cumulative(arg=None, currentbin=None, direction=None, enabled=None, **kwargs)¶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.
[‘include’, ‘exclude’, ‘half’]
Any
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.
[‘increasing’, ‘decreasing’]
Any
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)
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)¶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
numpy.ndarray
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
numpy.ndarray
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
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
color¶Sets the stroke color of the error bars.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
copy_ystyle¶The ‘copy_ystyle’ property must be specified as a bool (either True, or False)
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)
thickness¶Sets the thickness (in px) of the error bars.
An int or float in the interval [0, inf]
int|float
traceref¶An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
tracerefminus¶An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
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.
[‘percent’, ‘constant’, ‘sqrt’, ‘data’]
Any
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.
An int or float in the interval [0, inf]
int|float
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
An int or float in the interval [0, inf]
int|float
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)
width¶Sets the width (in px) of the cross-bar at both ends of the error bars.
An int or float in the interval [0, inf]
int|float
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)¶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
numpy.ndarray
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
numpy.ndarray
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
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
color¶Sets the stroke color of the error bars.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
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)
thickness¶Sets the thickness (in px) of the error bars.
An int or float in the interval [0, inf]
int|float
traceref¶An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
tracerefminus¶An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
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.
[‘percent’, ‘constant’, ‘sqrt’, ‘data’]
Any
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.
An int or float in the interval [0, inf]
int|float
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
An int or float in the interval [0, inf]
int|float
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)
width¶Sets the width (in px) of the cross-bar at both ends of the error bars.
An int or float in the interval [0, inf]
int|float
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)¶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
[‘left’, ‘right’, ‘auto’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
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
bgcolor¶Sets the background color of the hover labels for this trace
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
A list or array of any of the above
str|numpy.ndarray
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
bordercolor¶Sets the border color of the hover labels for this trace.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
A list or array of any of the above
str|numpy.ndarray
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
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.FontA dict of string/value properties that will be passed to the Font constructor
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.
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
int|numpy.ndarray
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)¶color¶A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
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.
A non-empty string
lineposition¶Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
The ‘lineposition’ property is a flaglist and may be specified as a string containing:
Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
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.
A string
A number that will be converted to a string
size¶An int or float in the interval [1, inf]
int|float
style¶Sets whether a font should be styled with a normal or italic face from its family.
[‘normal’, ‘italic’]
Any
textcase¶Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
Any
variant¶Sets the variant of the font.
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
Any
plotly.graph_objects.histogram.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)¶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.FontA dict of string/value properties that will be passed to the Font constructor
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, cornerradius=None, line=None, opacity=None, opacitysrc=None, pattern=None, reversescale=None, showscale=None, **kwargs)¶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)
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)
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.
An int or float
int|float
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.
An int or float
int|float
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.
An int or float
int|float
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.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
A number that will be interpreted as a color according to histogram.marker.colorscale
A list or array of any of the above
str|numpy.ndarray
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.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.histogram.marker.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
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.
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
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
Any
line¶The ‘line’ property is an instance of Line that may be specified as:
An instance of
plotly.graph_objects.histogram.marker.LineA dict of string/value properties that will be passed to the Line constructor
opacity¶Sets the opacity of the bars.
An int or float in the interval [0, 1]
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
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
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.PatternA dict of string/value properties that will be passed to the Pattern constructor
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)
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)¶color¶A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
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.
A non-empty string
lineposition¶Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
The ‘lineposition’ property is a flaglist and may be specified as a string containing:
Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
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.
A string
A number that will be converted to a string
size¶An int or float in the interval [1, inf]
int|float
style¶Sets whether a font should be styled with a normal or italic face from its family.
[‘normal’, ‘italic’]
Any
textcase¶Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
Any
variant¶Sets the variant of the font.
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
Any
plotly.graph_objects.histogram.Selected(arg=None, marker=None, textfont=None, **kwargs)¶marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.histogram.selected.MarkerA dict of string/value properties that will be passed to the Marker constructor
textfont¶The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.histogram.selected.TextfontA dict of string/value properties that will be passed to the Textfont constructor
plotly.graph_objects.histogram.Stream(arg=None, maxpoints=None, token=None, **kwargs)¶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.
An int or float in the interval [0, 10000]
int|float
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.
A non-empty string
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)¶color¶A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
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.
A non-empty string
lineposition¶Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
The ‘lineposition’ property is a flaglist and may be specified as a string containing:
Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
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.
A string
A number that will be converted to a string
size¶An int or float in the interval [1, inf]
int|float
style¶Sets whether a font should be styled with a normal or italic face from its family.
[‘normal’, ‘italic’]
Any
textcase¶Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
Any
variant¶Sets the variant of the font.
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
Any
plotly.graph_objects.histogram.Unselected(arg=None, marker=None, textfont=None, **kwargs)¶marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.histogram.unselected.MarkerA dict of string/value properties that will be passed to the Marker constructor
textfont¶The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.histogram.unselected.TextfontA dict of string/value properties that will be passed to the Textfont constructor
plotly.graph_objects.histogram.XBins(arg=None, end=None, size=None, start=None, **kwargs)¶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
Any
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
Any
Sets the size of each x axis bin. Default behavior
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
Any
plotly.graph_objects.histogram.YBins(arg=None, end=None, size=None, start=None, **kwargs)¶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
Any
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
Any
Sets the size of each y axis bin. Default behavior
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
Any