Interface: DensityHeatmapOptions
Options of densityHeatmap: px.density_heatmap's arguments in camelCase.
Extends
DensityOptions.ContinuousColorOptions
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. | DensityOptions.animationFrame |
animationGroup? | readonly | ColumnRef | Column matching rows across frames (ids), so each object moves rather than being replaced. | DensityOptions.animationGroup |
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). | DensityOptions.categoryOrders |
colorContinuousMidpoint? | readonly | number | cmid: the value at the middle of a diverging colorscale. | ContinuousColorOptions.colorContinuousMidpoint |
colorContinuousScale? | readonly | ContinuousScale | Colorscale of a numeric color. Default: the template's sequential colorscale. | ContinuousColorOptions.colorContinuousScale |
customData? | readonly | readonly ColumnRef[] | Columns put in customdata (first, before hoverData's), e.g. for click handlers. | DensityOptions.customData |
facetCol? | readonly | ColumnRef | Column whose values make the columns of subplots. | DensityOptions.facetCol |
facetColSpacing? | readonly | number | Space between facet columns, as a fraction of the plot width. Default 0.02. | DensityOptions.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). | DensityOptions.facetColWrap |
facetRow? | readonly | ColumnRef | Column whose values make the rows of subplots (first value at the top). | DensityOptions.facetRow |
facetRowSpacing? | readonly | number | Space between facet rows, as a fraction of the plot height. Default 0.03 (0.07 wrapped). | DensityOptions.facetRowSpacing |
height? | readonly | number | Figure height in px (layout.height). | DensityOptions.height |
histfunc? | readonly | "count" | "sum" | "avg" | "min" | "max" | Aggregation of z: default 'count', 'sum' when z is given. | DensityOptions.histfunc |
histnorm? | readonly | "probability" | "percent" | "probability density" | "density" | 'percent', 'probability', 'density', 'probability density'. | DensityOptions.histnorm |
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). | DensityOptions.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. | DensityOptions.labels |
logX? | readonly | boolean | Log x axis (type: 'log', on every facet). | DensityOptions.logX |
logY? | readonly | boolean | Log y axis. | DensityOptions.logY |
marginalX? | readonly | MarginalKind | Distribution of x drawn above the plot, sharing its x axis. | DensityOptions.marginalX |
marginalY? | readonly | MarginalKind | Distribution of y drawn right of the plot, sharing its y axis. | DensityOptions.marginalY |
nbinsx? | readonly | number | Maximum number of x bins. | DensityOptions.nbinsx |
nbinsy? | readonly | number | Maximum number of y bins. | DensityOptions.nbinsy |
rangeColor? | readonly | readonly [number, number] | [cmin, cmax] of the colorscale. | ContinuousColorOptions.rangeColor |
rangeX? | readonly | readonly [unknown, unknown] | Fixed x range, in data units (log axes take data units too, as px). | DensityOptions.rangeX |
rangeY? | readonly | readonly [unknown, unknown] | Fixed y range, in data units. | DensityOptions.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. | DensityOptions.template |
title? | readonly | string | Figure title (layout.title.text). | DensityOptions.title |
width? | readonly | number | Figure width in px (layout.width). | DensityOptions.width |
x? | readonly | ColumnRef | Column of x values. | DensityOptions.x |
y? | readonly | ColumnRef | Column of y values. | DensityOptions.y |
z? | readonly | ColumnRef | Column aggregated per cell by histfunc (default: counts of rows). | DensityOptions.z |