MAIDR JavaScript API
    Preparing search index...

    Interface ExcelSeriesSnapshot

    One series of a chart, read.

    The dimension arrays are exactly what getDimensionValues returned: strings, with a blank cell as ''. Which of them are present depends on what the series is drawn as -- xValues and yValues for a scatter, categories and values for everything else -- and none are read for a series the reading skips.

    interface ExcelSeriesSnapshot {
        name: string;
        chartType?: string;
        axisGroup?: "Primary" | "Secondary";
        filtered?: boolean;
        firstSliceAngle?: number;
        categories?: readonly string[];
        values?: readonly string[];
        xValues?: readonly string[];
        yValues?: readonly string[];
        bubbleSizes?: readonly string[];
        sizeHeader?: string;
        splitType?: string;
        splitValue?: number;
        binOptions?: ExcelBinOptionsSnapshot;
        quartileCalculation?: string;
        totals?: readonly number[];
    }
    Index

    Properties

    name chartType? axisGroup? filtered? firstSliceAngle? categories? values? xValues? yValues? bubbleSizes? sizeHeader? splitType? splitValue? binOptions? quartileCalculation? totals?

    Properties

    name: string
    chartType?: string

    What the series is drawn as; the chart's type when absent.

    axisGroup?: "Primary" | "Secondary"

    Which value axis the series is measured on. Default Primary.

    filtered?: boolean

    Hidden by a chart filter, so not drawn and not read.

    firstSliceAngle?: number

    A pie's first slice angle, in degrees clockwise from 12 o'clock.

    categories?: readonly string[]
    values?: readonly string[]
    xValues?: readonly string[]
    yValues?: readonly string[]
    bubbleSizes?: readonly string[]

    A bubble chart's sizes, one per point.

    sizeHeader?: string

    The header cell above the bubble sizes (ExcelApi 1.15), which names what a bubble's size measures.

    splitType?: string

    A pie of pie's or bar of pie's split; see ExcelChartSeries.splitType.

    splitValue?: number
    binOptions?: ExcelBinOptionsSnapshot

    A histogram's or Pareto chart's binning.

    quartileCalculation?: string

    A box and whisker chart's quartile calculation, Inclusive or Exclusive.

    totals?: readonly number[]

    A waterfall's points set as totals, by position (Excel's Set as total). Office.js does not report them, so a read never has them; a snapshot written by hand can.

    Settings

    Member Visibility

    On This Page

    Properties