MAIDR JavaScript API
    Preparing search index...

    Interface ExcelChartSeries

    One series of a chart (Excel.ChartSeries).

    Enumerated properties are declared as string: Office.js types them as an enum or its string values, and an enum member is not assignable to a string literal.

    interface ExcelChartSeries {
        load: (propertyNames?: string | string[]) => unknown;
        name: string;
        chartType: string;
        axisGroup: string;
        filtered: boolean;
        firstSliceAngle: number;
        splitType: string;
        splitValue: number;
        binOptions: ExcelChartBinOptions;
        boxwhiskerOptions: ExcelChartBoxwhiskerOptions;
        getDimensionValues: (
            dimension: ExcelChartSeriesDimension,
        ) => ExcelClientResult<string[]>;
        getDimensionDataSourceString: (
            dimension: ExcelChartSeriesDimension,
        ) => ExcelClientResult<string>;
        getDimensionDataSourceType: (
            dimension: ExcelChartSeriesDimension,
        ) => ExcelClientResult<string>;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    The series name, as the legend shows it (ExcelApi 1.1).

    chartType: string

    What this series is drawn as (ExcelApi 1.7). In a combo chart each series carries its own type, a column series beside a line series.

    axisGroup: string

    Primary or Secondary: which value axis the series is measured on (ExcelApi 1.8).

    filtered: boolean

    Whether a chart filter hides the series (ExcelApi 1.7). A filtered series is not drawn.

    firstSliceAngle: number

    The angle of a pie's first slice, in degrees clockwise from 12 o'clock (ExcelApi 1.8). Valid only on a pie or doughnut series.

    splitType: string

    How a pie of pie or bar of pie splits its points between the two plots: SplitByPosition, SplitByValue, SplitByPercentValue or SplitByCustomSplit (ExcelApi 1.8).

    splitValue: number

    The threshold of that split: how many points, from the end, for a split by position; the value or the percentage below which a point is split off otherwise (ExcelApi 1.9).

    A histogram's or Pareto chart's binning (ExcelApi 1.9).

    boxwhiskerOptions: ExcelChartBoxwhiskerOptions

    A box and whisker chart's quartile calculation (ExcelApi 1.9).

    getDimensionValues: (
        dimension: ExcelChartSeriesDimension,
    ) => ExcelClientResult<string[]>

    The values of one dimension, as strings (ExcelApi 1.12).

    getDimensionDataSourceString: (
        dimension: ExcelChartSeriesDimension,
    ) => ExcelClientResult<string>

    Where a dimension's values come from, such as Sheet1!$A$2:$A$9 (ExcelApi 1.15).

    getDimensionDataSourceType: (
        dimension: ExcelChartSeriesDimension,
    ) => ExcelClientResult<string>

    What kind of source that is: LocalRange, ExternalRange, List or Unknown (ExcelApi 1.15).