API Reference
< Back to docs
Switch to new Anvil Editor docs Switch to Classic Editor docs
You are currently viewing the new Anvil Editor Docs.
Switch to the Classic Editor Docs
You are currently viewing the Classic Editor Docs.
Switch to the new Anvil Editor Docs

plotly.graph_objs.histogram Module

Globals

Functions

plotly.graph_objs.histogram.Cumulative([currentbin=], [direction=], [enabled=]) → Cumulative

Create a new ‘Cumulative’ object

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

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

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

plotly.graph_objs.histogram.ErrorX([_deprecated=], [array=], [arrayminus=], [arrayminussrc=], [arraysrc=], [color=], [copy_ystyle=], [symmetric=], [thickness=], [traceref=], [tracerefminus=], [type=], [value=], [valueminus=], [visible=], [width=]) → ErrorX

Create a new ‘ErrorX’ object

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

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

  • arrayminussrc - Sets the source reference on Chart Studio Cloud for `arrayminus`.

  • arraysrc - Sets the source reference on Chart Studio Cloud for `array`.

  • color - Sets the stoke color of the error bars.

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

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

  • 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`.

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

  • 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

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

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

plotly.graph_objs.histogram.ErrorY([_deprecated=], [array=], [arrayminus=], [arrayminussrc=], [arraysrc=], [color=], [symmetric=], [thickness=], [traceref=], [tracerefminus=], [type=], [value=], [valueminus=], [visible=], [width=]) → ErrorY

Create a new ‘ErrorY’ object

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

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

  • arrayminussrc - Sets the source reference on Chart Studio Cloud for `arrayminus`.

  • arraysrc - Sets the source reference on Chart Studio Cloud for `array`.

  • color - Sets the stoke color of the error bars.

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

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

  • 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`.

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

  • 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

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

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

plotly.graph_objs.histogram.Hoverlabel([align=], [alignsrc=], [bgcolor=], [bgcolorsrc=], [bordercolor=], [bordercolorsrc=], [font=], [namelength=], [namelengthsrc=]) → Hoverlabel

Create a new ‘Hoverlabel’ object

  • 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

  • alignsrc - Sets the source reference on Chart Studio Cloud for `align`.

  • bgcolor - Sets the background color of the hover labels for this trace

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

  • bordercolor - Sets the border color of the hover labels for this trace.

  • bordercolorsrc - Sets the source reference on Chart Studio Cloud for `bordercolor`.

  • font - Sets the font used in hover labels.

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

  • namelengthsrc - Sets the source reference on Chart Studio Cloud for `namelength`.

plotly.graph_objs.histogram.Insidetextfont([color=], [family=], [size=]) → Insidetextfont

Create a new ‘Insidetextfont’ object

  • 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*.

plotly.graph_objs.histogram.Legendgrouptitle([font=], [text=]) → Legendgrouptitle

Create a new ‘Legendgrouptitle’ object

  • font - Sets this legend group's title font.

  • text - Sets the title of the legend group.

plotly.graph_objs.histogram.Marker([autocolorscale=], [cauto=], [cmax=], [cmid=], [cmin=], [color=], [coloraxis=], [colorbar=], [colorscale=], [colorsrc=], [line=], [opacity=], [opacitysrc=], [pattern=], [reversescale=], [showscale=]) → Marker

Create a new ‘Marker’ object

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

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

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

  • 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`.

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

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

  • 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.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,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

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

  • opacity - Sets the opacity of the bars.

  • opacitysrc - Sets the source reference on Chart Studio Cloud for `opacity`.

  • pattern - Sets the pattern within the marker.

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

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

plotly.graph_objs.histogram.Outsidetextfont([color=], [family=], [size=]) → Outsidetextfont

Create a new ‘Outsidetextfont’ object

  • 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*.

plotly.graph_objs.histogram.Selected([marker=], [textfont=]) → Selected

Create a new ‘Selected’ object

    plotly.graph_objs.histogram.Stream([maxpoints=], [token=]) → Stream

    Create a new ‘Stream’ object

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

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

    plotly.graph_objs.histogram.Textfont([color=], [family=], [size=]) → Textfont

    Create a new ‘Textfont’ object

    • 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*.

    plotly.graph_objs.histogram.Transform() → Transform

    Create a new ‘Transform’ object

    plotly.graph_objs.histogram.Unselected([marker=], [textfont=]) → Unselected

    Create a new ‘Unselected’ object

      plotly.graph_objs.histogram.XBins([end=], [size=], [start=]) → XBins

      Create a new ‘XBins’ object

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

      • size - Sets the size of each x axis bin. Default behavior: 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.

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

      plotly.graph_objs.histogram.YBins([end=], [size=], [start=]) → YBins

      Create a new ‘YBins’ object

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

      • size - Sets the size of each y axis bin. Default behavior: 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.

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

      Globals

      Do you still have questions?

      Our Community Forum is full of helpful information and Anvil experts.

      plotly.graph_objs.heatmapgl.legendgrouptitle plotly.graph_objs.histogram.hoverlabel

      plotly.graph_objs.histogram