MAIDR Documentation - v4.4.0
    Preparing search index...

    Interface ParallelDeclaration

    One polyline per observation across several axes, one axis per variable.

    Every column is a different quantity, so a value is pitched against its own axis rather than against one range for the layer — which is why the axes must be named and why they must be named in draw order.

    interface ParallelDeclaration {
        title?: string;
        name?: string;
        type: PARALLEL;
        dimensions: (string | { label?: string; key: string })[];
        label?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    title?: string

    Overrides the layer's announced title. Maps to MaidrLayer.title.

    Names the chart; use DeclarationBase.name to say which layer of it this is.

    name?: string

    Names this layer among sibling layers. Maps to MaidrLayer.name.

    Announced on a layer switch in place of the trace type, so a hue-split figure says "Male" and "Female" rather than "error_bar plot" twice.

    type: PARALLEL

    TraceType.PARALLEL — the string 'parallel_coordinates', not 'parallel'.

    dimensions: (string | { label?: string; key: string })[]

    The axes, in the order they are drawn — which is the order a reader arrows through them.

    Required, and required to be a list: nothing on the observation says it, an object's key order is not an axis order and must never be used as one, and a guessed order would announce the chart's columns in the wrong places.

    A bare string names both the axis and the raw, un-normalised field on the observation. The object form separates them, for a chart whose column key is not what a reader should hear. Either way the field named is the value before the chart scaled it to the axis: a trace derives each column's own extent, so it must never see 0–1 values.

    dimensions: ['mpg', 'hp', { label: 'Weight (lb)', key: 'wt' }]
    
    label?: string

    Field holding the observation's name, announced as its series name.

    The default chain is the genomics one, so a row carrying an id or a name column resolves to it. Where that column is chart plumbing rather than the observation's name, name the field explicitly.

    'label', falling back to snp, id, name, gene or probe