Interface: HistogramOptions
Options of histogram: px.histogram's arguments in camelCase.
Extends
CommonOptions.XYOptions.DiscreteColorOptions.PatternOptions.HoverOptions.FacetOptions.AnimationFrameOptions.AxisOptions
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
animationFrame? | readonly | ColumnRef | Column of frame values: one frame per value (in categoryOrders / first-appearance order), with a Play / Pause update menu and a slider. Axis ranges are fixed across frames. | AnimationFrameOptions.animationFrame |
animationGroup? | readonly | ColumnRef | Column matching rows across frames (ids), so each object moves rather than being replaced. | AnimationFrameOptions.animationGroup |
barmode? | readonly | "relative" | "group" | "overlay" | "stack" | layout.barmode: 'relative' (default), 'group', 'overlay', 'stack'. | - |
barnorm? | readonly | "percent" | "fraction" | layout.barnorm: 'fraction' or 'percent' of each bin's total. | - |
categoryOrders? | readonly | Readonly<Record<string, readonly unknown[]>> | Value orders per column: { day: ['Thu', 'Fri', 'Sat', 'Sun'] }. They order the traces and legend (for grouping columns), facets, frames and category axes. Values not listed follow in order of first appearance; listed values without rows still take a color and a facet (as px). | CommonOptions.categoryOrders |
color? | readonly | ColumnRef | Column to color by. | DiscreteColorOptions.color |
colorDiscreteMap? | readonly | Readonly<Record<string, string>> | "identity" | Fixed colors per value of color ({ Asia: 'red' }); other values continue with the sequence. 'identity': the values are colors themselves (no legend entries for them). | DiscreteColorOptions.colorDiscreteMap |
colorDiscreteSequence? | readonly | readonly string[] | Colors for the values of color, in order. Default: the template's colorway. | DiscreteColorOptions.colorDiscreteSequence |
cumulative? | readonly | boolean | Cumulative histogram. | - |
customData? | readonly | readonly ColumnRef[] | Columns put in customdata (first, before hoverData's), e.g. for click handlers. | HoverOptions.customData |
facetCol? | readonly | ColumnRef | Column whose values make the columns of subplots. | FacetOptions.facetCol |
facetColSpacing? | readonly | number | Space between facet columns, as a fraction of the plot width. Default 0.02. | FacetOptions.facetColSpacing |
facetColWrap? | readonly | number | Wrap facetCol after this many columns (row by row from the top). Ignored with facetRow or a marginal. Default 0 (no wrapping). | FacetOptions.facetColWrap |
facetRow? | readonly | ColumnRef | Column whose values make the rows of subplots (first value at the top). | FacetOptions.facetRow |
facetRowSpacing? | readonly | number | Space between facet rows, as a fraction of the plot height. Default 0.03 (0.07 wrapped). | FacetOptions.facetRowSpacing |
height? | readonly | number | Figure height in px (layout.height). | CommonOptions.height |
histfunc? | readonly | "count" | "sum" | "avg" | "min" | "max" | Aggregation of the other column (y of a vertical histogram): default 'count', 'sum' when both x and y are given. | - |
histnorm? | readonly | "probability" | "percent" | "probability density" | "density" | '' (counts), 'percent', 'probability', 'density', 'probability density'. | - |
hoverData? | readonly | | readonly ColumnRef[] | Readonly<Record<string, string | boolean>> | More columns for the hover label, through customdata: a list of columns, or an object that adds columns (true), removes lines (false, e.g. { x: false }) or formats them (':.2f', `' | %Y'`). |
hoverName? | readonly | ColumnRef | Column shown in bold at the top of the hover label (hovertext). | HoverOptions.hoverName |
labels? | readonly | Readonly<Record<string, string>> | Display names of columns: { gdpPercap: 'GDP per capita' }. Used for axis titles, hover lines, the legend title, facet labels, the colorbar title and the animation slider. | CommonOptions.labels |
logX? | readonly | boolean | Log x axis (type: 'log', on every facet). | AxisOptions.logX |
logY? | readonly | boolean | Log y axis. | AxisOptions.logY |
marginal? | readonly | MarginalKind | Distribution of the same values drawn alongside (above a vertical histogram). | - |
nbins? | readonly | number | Maximum number of bins (nbinsx, or nbinsy horizontal). | - |
opacity? | readonly | number | Bar opacity, 0–1. | - |
orientation? | readonly | "v" | "h" | 'v' or 'h'. Default as px: 'h' when only the value column of a horizontal chart is given or when x is numeric and y is not, else 'v'. | XYOptions.orientation |
pattern? | readonly | ColumnRef | Column whose values get different fill patterns. | PatternOptions.pattern |
patternShapeMap? | readonly | Readonly<Record<string, string>> | "identity" | Fixed shapes per value; 'identity': the values are shapes. | PatternOptions.patternShapeMap |
patternShapeSequence? | readonly | readonly string[] | Shapes in order. Default: '', /, \, x, +, .. | PatternOptions.patternShapeSequence |
rangeX? | readonly | readonly [unknown, unknown] | Fixed x range, in data units (log axes take data units too, as px). | AxisOptions.rangeX |
rangeY? | readonly | readonly [unknown, unknown] | Fixed y range, in data units. | AxisOptions.rangeY |
template? | readonly | string | Template | layout.template: a registered name ('plotly-classic') or a template object. Default: unset, so the chart's default template applies (Holochart's holochart look); its colorway, symbol and dash cycles and sequential colorscale are what the figure's colors are taken from. | CommonOptions.template |
title? | readonly | string | Figure title (layout.title.text). | CommonOptions.title |
width? | readonly | number | Figure width in px (layout.width). | CommonOptions.width |
x? | readonly | ColumnRef | Column of x values. | XYOptions.x |
y? | readonly | ColumnRef | Column of y values. | XYOptions.y |