MAIDR JavaScript API
    Preparing search index...

    Interface OfficeBinding

    A mounted pane, returned by bindPowerPoint and bindWord.

    interface OfficeBinding {
        host: OfficeDocumentHostName;
        maidr: Maidr | null;
        chart: OfficeChartInfo | null;
        charts: readonly OfficeChartInfo[];
        show: (chartId?: string) => Promise<void>;
        refresh: () => Promise<void>;
        dispose: () => Promise<void>;
    }
    Index

    Properties

    host maidr chart charts show refresh dispose

    Properties

    host: OfficeDocumentHostName

    Which application the pane reads.

    maidr: Maidr | null

    The figure on show, or null while the pane shows a message instead.

    chart: OfficeChartInfo | null

    The chart on show, or null when none is.

    charts: readonly OfficeChartInfo[]

    Every chart the picker offers.

    show: (chartId?: string) => Promise<void>

    Show a chart, by its id from OfficeBinding.charts; with no id, the chart shown already, or else the first. Never rejects.

    refresh: () => Promise<void>

    Read the file again, and show the chart on show again, or the first. Never rejects.

    dispose: () => Promise<void>

    Stop following the selection, unmount MAIDR and remove the pane.

    Settings

    Member Visibility

    On This Page

    Properties