MAIDR JavaScript API
    Preparing search index...

    Interface PowerBIBindOptions

    Options for bindPowerBI.

    interface PowerBIBindOptions {
        chart?: HTMLElement | SVGElement;
        onNavigate?: (points: readonly PowerBIDataPointRef[] | null) => void;
        label?: string;
        emptyLabel?: string;
        live?: boolean;
        chartType: PowerBIChartType;
        barMode?: PowerBIBarMode;
        title?: string;
        subtitle?: string;
        caption?: string;
        axes?: { x?: string; y?: string };
        roles?: PowerBIRoleNames;
        id?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    chart?: HTMLElement | SVGElement

    The visual's own drawing. Moved inside MAIDR's figure, so it becomes the chart the reader navigates. Omit it for companion mode.

    onNavigate?: (points: readonly PowerBIDataPointRef[] | null) => void

    Called as the reader moves, with the data points under MAIDR's cursor, and with null when the reader leaves the chart — focus moves out of the visual, or the visual's frame loses focus to another part of the report. Highlight the marks, or build selection ids from the refs and call selectionManager.select(); clear them on null.

    label?: string

    The visible text of companion mode's entry point. Default: the title, or "Accessible chart". Screen readers hear MAIDR's own instruction instead: the entry point is an image to them, named by MAIDR.

    emptyLabel?: string

    What the focusable empty state says when the data view holds nothing to navigate — no fields bound, or a filter that leaves no rows. Default "No data to read".

    live?: boolean

    Apply new data in place while the reader is inside the chart, keeping their position. On by default, unlike the Tableau binder: a visual's frame keeps its focused element when the reader moves to a slicer, so MAIDR cannot tell that they left, and data held back "until they leave" would be held until they happened to tab out of the visual — the reader would come back from changing a filter to the unfiltered chart. Pass false to hold new data until focus leaves the visual itself.

    chartType: PowerBIChartType

    The chart the visual draws. See PowerBIChartType.

    barMode?: PowerBIBarMode

    How a multi-series bar or column chart is drawn. Default grouped.

    title?: string

    Chart title announced on entry.

    subtitle?: string
    caption?: string
    axes?: { x?: string; y?: string }

    Axis labels. Default: the display names of the fields bound to each axis — for a pie, the category and measure names.

    Role names, when the visual's capabilities use other ones.

    id?: string

    The figure id. Must be unique on the page; default maidr-powerbi-<n>.