MAIDR JavaScript API
    Preparing search index...

    Interface ExcelChart

    A chart (Excel.Chart).

    interface ExcelChart {
        load: (propertyNames?: string | string[]) => unknown;
        id: string;
        name: string;
        chartType: string;
        displayBlanksAs: string;
        title: ExcelTitle;
        axes: ExcelChartAxes;
        series: ExcelChartSeriesCollection;
        worksheet: ExcelWorksheet;
        isNullObject?: boolean;
        getImage: (width?: number) => ExcelClientResult<string>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    load id name chartType displayBlanksAs title axes series worksheet isNullObject? getImage

    Properties

    load: (propertyNames?: string | string[]) => unknown
    id: string

    ExcelApi 1.7.

    name: string

    The chart object's name, such as Chart 1 (ExcelApi 1.1).

    chartType: string

    ExcelApi 1.7; see Excel.ChartType.

    displayBlanksAs: string

    How a blank cell is plotted: NotPlotted, Zero or Interplotted (ExcelApi 1.8).

    title: ExcelTitle

    ExcelApi 1.1.

    axes: ExcelChartAxes

    ExcelApi 1.1.

    series: ExcelChartSeriesCollection

    ExcelApi 1.1.

    worksheet: ExcelWorksheet

    The worksheet the chart is on (ExcelApi 1.2).

    isNullObject?: boolean

    true when an …OrNullObject method found no chart. Present on every Office.js object; read only after getActiveChartOrNullObject.

    getImage: (width?: number) => ExcelClientResult<string>

    The chart as Excel draws it, a base64-encoded PNG, scaled to width with its aspect ratio kept (ExcelApi 1.2).

    Settings

    Member Visibility

    On This Page

    Properties