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

    Interface AlluvialDeclaration

    Categories that stay put while a quantity is re-divided between them at each step — an alluvial diagram.

    The same weighted flow a sankey carries, drawn without a left-to-right budget, so it needs nothing declared beyond which of the two it is: the nodes, the links and their magnitudes are already in the drawing.

    interface AlluvialDeclaration {
        title?: string;
        name?: string;
        type: ALLUVIAL;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    TraceType.ALLUVIAL — the string 'alluvial'.