Skip to content

Interface: ParcatsTraceDimension ​

One item of dimensions.

Template defaults for every item go in dimensiondefaults.

Properties ​

PropertyTypeDefault valueDescription
categoryarray?DataColumnundefinedThe category order with categoryorder: 'array'.
categoryorder?"trace" | "category ascending" | "category descending" | "array"undefinedOrder of the categories, top to bottom: first appearance ('trace'), sorted, or categoryarray (then unlisted values by appearance). Default: 'array' when categoryarray is given, else 'trace'. Dragging a category restyles it to 'array'.
displayindex?numberundefinedPosition of this dimension, left to right. Default: its index. Used only when the visible dimensions form a permutation of 0 … n − 1; dragging a dimension restyles it.
label?stringundefinedDimension title, drawn above it.
name?stringundefinedName of this dimension, used to reference it from a template via templateitemname.
templateitemname?stringundefinedName of a template dimension to inherit from. If no template item matches, this dimension is hidden (visible: false).
ticktext?DataColumnundefinedCategory labels, one per categoryarray entry (categoryorder: 'array' only). Default: the values.
values?DataColumnundefinedThe category of each sample in this dimension. A dimension without values is hidden.
visible?booleantrueShow this dimension. Hidden dimensions keep their place in dimensions.

Released under the MIT License.