Skip to content

Interface: StripFigureOptions ​

Options of strip: the camelCase counterparts of px.strip's parameters.

Properties ​

PropertyModifierTypeDescription
categoryOrders?readonlyReadonly<Record<string, readonly unknown[]>>Value orders per column: { day: ['Thu', 'Fri', 'Sat', 'Sun'] } orders the categories of the axis, { [color]: [...] } the traces and legend. Values not listed follow in order of first appearance.
color?readonlystringColumn to group by: one trace (color and legend item) per distinct value.
colorDiscreteMap?readonlyReadonly<Record<string, string>>Fixed colors per color value. Other values take colorDiscreteSequence, else the colorway.
colorDiscreteSequence?readonlyreadonly string[]Colors for color values in order. Default: the template's colorway.
datareadonlyStripDataThe table: an array of row objects, or an object of equally long columns.
hoverData?readonlyreadonly string[]Extra columns listed in the hover label (through customdata).
hoverName?readonlystringColumn shown in bold at the top of the hover label.
jitter?readonlynumberSpread of the points across the strip, 0–1 of its width (the box jitter). Default 0.3 (Plotly's default for boxpoints: 'all'). A Holochart option; px has none.
labels?readonlyReadonly<Record<string, string>>Display names of columns, for hover lines, the legend title and the axis titles.
orientation?readonly"v" | "h"'v': strips at x categories over y values; 'h': at y categories. Default (as px): 'h' when only x is given or when x is numeric and y is not, else 'v'.
stripmode?readonly"overlay" | "group"'group' (default): color groups side by side at each category; 'overlay': on one strip.
title?readonlystringFigure title.
x?readonlystringColumn of x values: categories for vertical strips, values for horizontal ones.
y?readonlystringColumn of y values.

Released under the MIT License.