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

    Interface ParallelAxesConfig

    Configuration for parallel coordinates plots. Required when chartType is 'parallel'.

    One data row is one OBSERVATION and one dimension is one axis, which is the transpose of what the chart is drawn from: a Recharts <Line> binds to a single yAxisId, so a polyline crossing axes with different units has to be drawn from values min-max normalised onto one shared scale, with one <Line> per observation over rows keyed by axis.

    MAIDR is unaffected by that — a parallel trace derives each column's own extent and pitches a value against its OWN axis — but it must never see the normalised numbers, since every axis would then run 0 to 1 and the chart's whole point would be flattened. So dimensions names the RAW fields, and data here is the observations rather than the array the chart draws.

    interface ParallelAxesConfig {
        dimensions: (string | { label?: string; key: string })[];
        labelKey?: string;
    }
    Index

    Properties

    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 an observation states the order, and an object's key order is not an axis order. A bare string names both the axis and the raw field; the object form separates them, for a column whose key is not what a reader should hear.

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

    Key holding what the observation IS — the car, the country, the patient. It becomes the polyline's series name, and without it an observation is announced by its position among the rest.

    Defaults to a label column, then snp, id, name, gene, probe.