Interface: HierarchyOptions
Options of sunburst, treemap and icicle: px's arguments in camelCase.
Extends
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
branchvalues? | readonly | "total" | "remainder" | How values add up: 'total' (default with path) or 'remainder' (the trace's default). | - |
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 |
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 |
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 |
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 |
ids? | readonly | ColumnRef | Column of node ids (ids), when labels repeat. | - |
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 |
maxdepth? | readonly | number | Levels drawn from the root down (maxdepth); -1 draws them all. | - |
names? | readonly | ColumnRef | Column of node labels (labels). | - |
parents? | readonly | ColumnRef | Column of parent ids (parents), '' for roots. | - |
path? | readonly | readonly ColumnRef[] | Columns of the levels, from the root down (['continent', 'country']): each row is a leaf, and every distinct path prefix a node, with its values summed. A missing entry ends a row's path early (its later entries must be missing too). Not with ids / parents. | - |
rangeColor? | readonly | readonly [number, number] | [cmin, cmax] of the colorscale. | ContinuousColorOptions.rangeColor |
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 |
values? | readonly | ColumnRef | Column of node sizes (values). With path, summed per node; default: one per row. | - |
width? | readonly | number | Figure width in px (layout.width). | CommonOptions.width |