MAIDR Documentation - v3.65.0
    Preparing search index...

    Interface VegaLiteEmbedOptions

    Options accepted by embed.

    interface VegaLiteEmbedOptions {
        id?: string;
        title?: string;
        domOrder?: "subject-major" | "series-major";
        embedOptions?: Record<string, unknown>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    id? title? domOrder? embedOptions?

    Properties

    id?: string

    Override the chart id (defaults to "vl-chart").

    title?: string

    Override the chart title (extracted from the spec by default).

    domOrder?: "subject-major" | "series-major"

    Override how MAIDR maps the rendered SVG of a segmented (stacked / normalised / dodged) bar trace back onto the 2-D data[seriesIndex][barIndex] grid. Supplied as a hint to MaidrLayer.domMapping.

    • 'series-major' — DOM emits all bars of one colour before moving to the next colour. This is Vega-Lite's default for stacked / normalised bars.
    • 'subject-major' — DOM emits all colours of one x-subject before moving to the next subject. This is Vega-Lite's default for dodged bars.

    Leave undefined to use the type-based defaults (stacked/normalised → series-major, dodged → subject-major). Only set this if your Vega-Lite spec uses a non-default mark order or transform that changes the DOM emission sequence.

    embedOptions?: Record<string, unknown>

    Options forwarded to vegaEmbed. By default actions: false is set but can be overridden here.

    Settings

    Member Visibility

    On This Page

    Properties