Interface: ViolinOptions
Options of violin: px.violin's arguments in camelCase.
Extends
CategoricalOptions
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. | CategoricalOptions.animationFrame |
animationGroup? | readonly | ColumnRef | Column matching rows across frames (ids), so each object moves rather than being replaced. | CategoricalOptions.animationGroup |
box? | readonly | boolean | Draw a box inside each violin. | - |
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). | CategoricalOptions.categoryOrders |
color? | readonly | ColumnRef | Column to color by. | CategoricalOptions.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). | CategoricalOptions.colorDiscreteMap |
colorDiscreteSequence? | readonly | readonly string[] | Colors for the values of color, in order. Default: the template's colorway. | CategoricalOptions.colorDiscreteSequence |
customData? | readonly | readonly ColumnRef[] | Columns put in customdata (first, before hoverData's), e.g. for click handlers. | CategoricalOptions.customData |
facetCol? | readonly | ColumnRef | Column whose values make the columns of subplots. | CategoricalOptions.facetCol |
facetColSpacing? | readonly | number | Space between facet columns, as a fraction of the plot width. Default 0.02. | CategoricalOptions.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). | CategoricalOptions.facetColWrap |
facetRow? | readonly | ColumnRef | Column whose values make the rows of subplots (first value at the top). | CategoricalOptions.facetRow |
facetRowSpacing? | readonly | number | Space between facet rows, as a fraction of the plot height. Default 0.03 (0.07 wrapped). | CategoricalOptions.facetRowSpacing |
height? | readonly | number | Figure height in px (layout.height). | CategoricalOptions.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). | CategoricalOptions.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. | CategoricalOptions.labels |
logX? | readonly | boolean | Log x axis (type: 'log', on every facet). | CategoricalOptions.logX |
logY? | readonly | boolean | Log y axis. | CategoricalOptions.logY |
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'. | CategoricalOptions.orientation |
points? | readonly | false | "outliers" | "suspectedoutliers" | "all" | Which points to draw: 'outliers', 'suspectedoutliers', 'all', false. | - |
rangeX? | readonly | readonly [unknown, unknown] | Fixed x range, in data units (log axes take data units too, as px). | CategoricalOptions.rangeX |
rangeY? | readonly | readonly [unknown, unknown] | Fixed y range, in data units. | CategoricalOptions.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. | CategoricalOptions.template |
title? | readonly | string | Figure title (layout.title.text). | CategoricalOptions.title |
violinmode? | readonly | "group" | "overlay" | layout.violinmode: 'group' or 'overlay'. | - |
width? | readonly | number | Figure width in px (layout.width). | CategoricalOptions.width |
x? | readonly | ColumnRef | Column of x values. | CategoricalOptions.x |
y? | readonly | ColumnRef | Column of y values. | CategoricalOptions.y |