Skip to content

Interface: PieOptions ​

Options of pie: px.pie's arguments in camelCase.

Extends ​

Properties ​

PropertyModifierTypeDescriptionInherited from
categoryOrders?readonlyReadonly<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?readonlyColumnRefColumn to color by.DiscreteColorOptions.color
colorContinuousMidpoint?readonlynumbercmid: the value at the middle of a diverging colorscale.ContinuousColorOptions.colorContinuousMidpoint
colorContinuousScale?readonlyContinuousScaleColorscale of a numeric color. Default: the template's sequential colorscale.ContinuousColorOptions.colorContinuousScale
colorDiscreteMap?readonlyReadonly<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?readonlyreadonly string[]Colors for the values of color, in order. Default: the template's colorway.DiscreteColorOptions.colorDiscreteSequence
customData?readonlyreadonly ColumnRef[]Columns put in customdata (first, before hoverData's), e.g. for click handlers.HoverOptions.customData
facetCol?readonlyColumnRefColumn whose values make the columns of subplots.FacetOptions.facetCol
facetColSpacing?readonlynumberSpace between facet columns, as a fraction of the plot width. Default 0.02.FacetOptions.facetColSpacing
facetColWrap?readonlynumberWrap facetCol after this many columns (row by row from the top). Ignored with facetRow or a marginal. Default 0 (no wrapping).FacetOptions.facetColWrap
facetRow?readonlyColumnRefColumn whose values make the rows of subplots (first value at the top).FacetOptions.facetRow
facetRowSpacing?readonlynumberSpace between facet rows, as a fraction of the plot height. Default 0.03 (0.07 wrapped).FacetOptions.facetRowSpacing
height?readonlynumberFigure height in px (layout.height).CommonOptions.height
hole?readonlynumberSize of the hole, 0–1 of the radius (a donut).-
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?readonlyColumnRefColumn shown in bold at the top of the hover label (hovertext).HoverOptions.hoverName
labels?readonlyReadonly<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
names?readonlyColumnRefColumn of sector names (labels). Rows with the same name add up.-
opacity?readonlynumberSector opacity, 0–1.-
rangeColor?readonlyreadonly [number, number][cmin, cmax] of the colorscale.ContinuousColorOptions.rangeColor
template?readonlystring | Templatelayout.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?readonlyColumnRefColumn of sector text.-
title?readonlystringFigure title (layout.title.text).CommonOptions.title
values?readonlyColumnRefColumn of sector sizes (values). Default: one per row.-
width?readonlynumberFigure width in px (layout.width).CommonOptions.width

Released under the MIT License.