Interface: AreaOptions

Options of area.

Extends

• Omit<LineOptions, "lineDash" | "lineDashSequence" | "lineDashMap">

Properties

Property	Modifier	Type	Description	Inherited from
agg?	readonly	AggFunction	Aggregate the rows of each line that share an x (y when horizontal): 'sum', 'avg', 'count', 'min', 'max', 'median' or a function of the values — one point per position, in order of first appearance. A Holochart extension (px.line draws every row).	LineOptions.agg
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
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
customData?	readonly	readonly ColumnRef[]	Columns put in customdata (first, before hoverData's), e.g. for click handlers.	HoverOptions.customData
errorX?	readonly	ColumnRef	Column of x error sizes (error_x.array).	ErrorBarOptions.errorX
errorXMinus?	readonly	ColumnRef	Column of x error sizes below (error_x.arrayminus).	ErrorBarOptions.errorXMinus
errorY?	readonly	ColumnRef	Column of y error sizes (error_y.array).	ErrorBarOptions.errorY
errorYMinus?	readonly	ColumnRef	Column of y error sizes below (error_y.arrayminus).	ErrorBarOptions.errorYMinus
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
groupnorm?	readonly	"percent" | "fraction"	Normalize the stacks: 'fraction' or 'percent' of each x's total.	-
height?	readonly	number	Figure height in px (layout.height).	CommonOptions.height
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
lineGroup?	readonly	ColumnRef	Column splitting lines within a color group (one line per value, same color and legend item).	LineOptions.lineGroup
lineShape?	readonly	string	line.shape: 'linear' (default), 'spline', 'hv', 'vh', 'hvh', 'vhv'.	LineOptions.lineShape
logX?	readonly	boolean	Log x axis (type: 'log', on every facet).	AxisOptions.logX
logY?	readonly	boolean	Log y axis.	AxisOptions.logY
markers?	readonly	boolean	Show markers at the points.	LineOptions.markers
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
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
symbol?	readonly	ColumnRef	Column whose values get different marker symbols (one trace per value).	SymbolOptions.symbol
symbolMap?	readonly	Readonly<Record<string, string>> | "identity"	Fixed symbols per value; 'identity': the values are symbols.	SymbolOptions.symbolMap
symbolSequence?	readonly	readonly string[]	Symbols in order. Default: the template's scatter symbols, else circle, diamond, square, x, cross.	SymbolOptions.symbolSequence
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
text?	readonly	ColumnRef	Column of text drawn at the points.	LineOptions.text
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