MAIDR JavaScript API
    Preparing search index...

    Interface ExcelBinding

    A mounted pane, returned by bindExcel.

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

    Properties

    maidr chart charts show refresh dispose

    Properties

    maidr: Maidr | null

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

    chart: ExcelChartInfo | null

    The chart on show, or null when none is.

    charts: readonly ExcelChartInfo[]

    Every chart the picker offers.

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

    Show a chart, by its id from ExcelBinding.charts; with no id, the chart shown already, or else the active chart, or else the first. Never rejects: a failure is shown in the pane and warned in the console.

    refresh: () => Promise<void>

    Re-read the chart list and the chart on show.

    dispose: () => Promise<void>

    Unregister every Office.js event handler, unmount MAIDR and remove the pane. The returned promise settles once Excel has the handlers removed.

    Settings

    Member Visibility

    On This Page

    Properties