SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface ISeries

    One series of a chart: what it is called and the cells it plots.

    Each part of a series is stated as a formula — Sales!$C$4:$C$15 — the way the file and a chart's own dialog state it. The formula is the contract: it is what can say #REF!, name a defined name, or point at another workbook. The get…Range forms resolve the plain case.

    interface ISeries {
        getCategoriesFormula(): string | null;
        getCategoriesRange(): ICellRange | null;
        getChartType(): string;
        getName(): string | null;
        getNameFormula(): string | null;
        getNameRange(): ICellRange | null;
        getValuesFormula(): string | null;
        getValuesRange(): ICellRange | null;
        isSecondaryAxis(): boolean;
    }
    Index
    getCategoriesFormula getCategoriesRange getChartType getName getNameFormula getNameRange getValuesFormula getValuesRange isSecondaryAxis

    • Returns the formula for the categories the values are plotted against — the x values of a scatter or bubble series — or null if the series states none.

      Returns string | null

    • Returns how the series is drawn. The same as IChart.getChartType except in a combo.

      Returns string

    • Returns the series' name, or null if it has none.

      Returns string | null

      A name that is a reference to a cell reads as that cell's text.

    • Returns the formula naming the series — Sales!$C$3 — or null when the name is written into the chart, or there is none.

      Returns string | null

    • Returns the formula for the values plotted, or null if the series states none.

      Returns string | null

      Values written into the chart rather than read from cells are an array literal: {1,2,3}.

    • Returns the cells getValuesFormula names.

      Returns ICellRange | null

      null when the formula is not one plain reference into this workbook: an array literal, a defined name, several areas, another workbook, or #REF!.

    • Returns true if the series is plotted against the secondary axes.

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Methods