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

    Interface ScatterDeclaration

    An ordinary scatter, declared rather than detected.

    Worth declaring for the two things a scatter cannot say for itself: that its points carry an identity beyond their coordinates, and that several series are one cloud.

    interface ScatterDeclaration {
        title?: string;
        name?: string;
        type: SCATTER;
        label?: string;
        merge?: boolean;
    }

    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: SCATTER

    TraceType.SCATTER — the string 'point', not 'scatter'. The grammar names the mark, and the value is what an adapter emits and what every warning prints.

    label?: string

    Field holding what each point is, announced alongside its coordinates wherever the emitted point carries a name.

    ScatterPoint has no label field today, so a plain point layer has nowhere to put one: declare volcano or manhattan where identity is the payload, which is where the grammar carries it. The key is accepted here rather than reported as unknown because it is the field's obvious home, and warning about a spelling the declaration documents would send an author looking for a typo they did not make.

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

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

    merge?: boolean

    Absorb following undeclared siblings of the same drawn kind into this layer, as ManhattanDeclaration.merge does.

    false