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

    Interface TableauAdapterOptions

    Options for bindTableau. The adapter's only configuration channel.

    interface TableauAdapterOptions {
        id?: string;
        title?: string;
        live?: boolean;
        worksheets?: string[];
        overrides?: Record<string, TableauWorksheetOverride>;
        anchorLabel?: string;
        layout?: "column" | "grid";
    }
    Index

    Properties

    id?: string

    Stable figure id. Defaults to maidr-tableau-<n>; kept across refreshes.

    title?: string

    Figure title.

    live?: boolean

    Opt in to in-place refresh while the user is inside the chart. Default false, so a filter change is picked up on the next focus-in rather than rebuilding the figure under a reader who is mid-navigation.

    worksheets?: string[]

    Worksheet names to include, in this order. Default: every worksheet.

    overrides?: Record<string, TableauWorksheetOverride>

    Per-worksheet overrides, keyed by worksheet name.

    anchorLabel?: string

    Text on the keyboard entry point rendered beside the viz.

    layout?: "column" | "grid"

    How a dashboard's worksheets are arranged into subplots.

    • 'grid' (default) — follow the dashboard's own geometry when it is readable and unambiguous, so Left and Right move along a row of the dashboard and Up and Down move between its rows. Every other case, including an older embedding library that reports no geometry at all, falls back to the column below without the page doing anything.
    • 'column' — always one worksheet per row, in the order the worksheets were added. The escape hatch for a dashboard whose geometry is readable but whose reading order the page knows better than the layout does.