MAIDR JavaScript API
    Preparing search index...

    Interface ExcelChartSnapshot

    Everything one read of a chart produced: a plain object, safe to keep, compare and hand to convertExcelChart after the request context is gone.

    interface ExcelChartSnapshot {
        id?: string;
        name?: string;
        worksheet?: string;
        chartType: string;
        displayBlanksAs?: string;
        title?: ExcelTitleSnapshot;
        axes?: {
            category?: ExcelAxisSnapshot;
            value?: ExcelAxisSnapshot;
            secondaryValue?: ExcelAxisSnapshot;
            series?: ExcelAxisSnapshot;
        };
        series: readonly ExcelSeriesSnapshot[];
        categoryLabels?: readonly string[];
        categoryLevels?: readonly (readonly string[])[];
        categoryHeader?: string;
        image?: string;
    }
    Index

    Properties

    id? name? worksheet? chartType displayBlanksAs? title? axes? series categoryLabels? categoryLevels? categoryHeader? image?

    Properties

    id?: string

    The chart's id, unique in the workbook.

    name?: string

    The chart object's name, such as Chart 1.

    worksheet?: string

    The name of the worksheet the chart is on.

    chartType: string

    Excel.ChartType; for a combo chart, Excel reports one of its types.

    displayBlanksAs?: string

    How a blank cell is plotted: NotPlotted, Zero or Interplotted.

    title?: ExcelTitleSnapshot
    axes?: {
        category?: ExcelAxisSnapshot;
        value?: ExcelAxisSnapshot;
        secondaryValue?: ExcelAxisSnapshot;
        series?: ExcelAxisSnapshot;
    }

    Type Declaration

    series: readonly ExcelSeriesSnapshot[]

    The series, in plot order, filtered ones included.

    categoryLabels?: readonly string[]

    The category cells' displayed text, one label per category (ExcelApi 1.15, a category range on a worksheet). Several label levels are joined, outer first. Preferred over categories when it lines up with them.

    categoryLevels?: readonly (readonly string[])[]

    The same cells' levels, outer first, one list per category, when the category range has more than one (ExcelApi 1.15). A blank outer cell is the one above it carried down, as Excel reads it. The hierarchy of a treemap or sunburst.

    categoryHeader?: string

    The header cell above (or before) the category range (ExcelApi 1.15), which names the category axis when the chart shows no axis title.

    image?: string

    The chart as Excel draws it, a base64-encoded PNG (Chart.getImage).

    Settings

    Member Visibility

    On This Page

    Properties