SheetXL - v1.0.2
    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 {
        isISeries: true;
        addChartTrendline(
            type?: TrendlineType,
            options?: ITransaction.OperationOptions,
        ): IChart.ITrendline;
        delete(options?: ITransaction.OperationOptions): void;
        getAxisGroup(): AxisGroup;
        getBubbleScale(): number | null;
        getBubbleSizeRepresents(): BubbleSizeRepresents | null;
        getBubbleSizesFormula(): string | null;
        getCategoriesFormula(): string | null;
        getCategoriesRange(): ICellRange | null;
        getChart(): IChart;
        getChartTrendline(index: number): IChart.ITrendline | null;
        getChartType(): string;
        getDataLabels(): IChart.IDataLabels;
        getDimensionValues(dimension: SeriesDimension): string[];
        getDropLines(): IChart.ILines;
        getElementType(): IChart.ElementType;
        getExplosion(): number;
        getFormula(): string;
        getGapWidth(): number | null;
        getHiLoLines(): IChart.ILines;
        getInvertIfNegative(): boolean;
        getMarker(): IChart.IMarker;
        getName(): string | null;
        getNameFormula(): string | null;
        getNameRange(): ICellRange | null;
        getOverlap(): number | null;
        getParent(): IElement | null;
        getPath(): string;
        getPlotOrder(): number;
        getPoints(): readonly IChart.IPoint[];
        getSecondPlotPoints(): number[];
        getSecondPlotSize(): number | null;
        getSeriesLines(): IChart.ILines;
        getShowNegativeBubbles(): boolean | null;
        getSmooth(): boolean;
        getSplitType(): SplitType | null;
        getSplitValue(): number | null;
        getStyle(): IShapeStyle;
        getTrendlines(): readonly IChart.ITrendline[];
        getUpDownBars(): IChart.IUpDownBars;
        getValuesFormula(): string | null;
        getValuesRange(): ICellRange | null;
        getVaryByCategories(): boolean;
        getXErrorBars(): IChart.IErrorBars;
        getYErrorBars(): IChart.IErrorBars;
        isSecondaryAxis(): boolean;
        setAxisGroup(
            group: AxisGroup,
            options?: ITransaction.OperationOptions,
        ): this;
        setBubbleScale(
            bubbleScale: number,
            options?: ITransaction.OperationOptions,
        ): this;
        setBubbleSizeRepresents(
            represents: BubbleSizeRepresents,
            options?: ITransaction.OperationOptions,
        ): this;
        setBubbleSizes(
            source: string | ICellRange,
            options?: ITransaction.OperationOptions,
        ): this;
        setChartType(type: string, options?: ITransaction.OperationOptions): this;
        setExplosion(
            explosion: number,
            options?: ITransaction.OperationOptions,
        ): this;
        setFormula(formula: string, options?: ITransaction.OperationOptions): this;
        setGapWidth(
            gapWidth: number,
            options?: ITransaction.OperationOptions,
        ): this;
        setInvertIfNegative(
            invert: boolean,
            options?: ITransaction.OperationOptions,
        ): this;
        setName(
            name: string | ICellRange | null,
            options?: ITransaction.OperationOptions,
        ): this;
        setOverlap(overlap: number, options?: ITransaction.OperationOptions): this;
        setPlotOrder(
            plotOrder: number,
            options?: ITransaction.OperationOptions,
        ): this;
        setSecondPlotPoints(
            points: readonly number[],
            options?: ITransaction.OperationOptions,
        ): this;
        setSecondPlotSize(
            secondPlotSize: number,
            options?: ITransaction.OperationOptions,
        ): this;
        setShowNegativeBubbles(
            show: boolean,
            options?: ITransaction.OperationOptions,
        ): this;
        setSmooth(smooth: boolean, options?: ITransaction.OperationOptions): this;
        setSplitType(
            splitType: SplitType,
            options?: ITransaction.OperationOptions,
        ): this;
        setSplitValue(
            splitValue: number,
            options?: ITransaction.OperationOptions,
        ): this;
        setValues(
            source: string | ICellRange,
            options?: ITransaction.OperationOptions,
        ): this;
        setVaryByCategories(
            vary: boolean,
            options?: ITransaction.OperationOptions,
        ): this;
        setXAxisValues(
            source: string | ICellRange | null,
            options?: ITransaction.OperationOptions,
        ): this;
        update(
            update: IChart.ISeries.Update,
            options?: ITransaction.OperationOptions,
        ): this;
    }

    Hierarchy (View Summary)

    Index
    isISeries: true

    For runtime type checking.

    • Adds a trendline to the series, as Excel adds one: a dotted 1.5 pt line in the series' color, with no label. A polynomial is of order 2 and a moving average of period 2 until set.

      Parameters

      Returns IChart.ITrendline

      ExpectedError on a series Excel draws no trendline for: a pie, doughnut, radar, surface, 3-D or stacked series, or a 2016 chart's.

    • Returns the axes the series is plotted against; a pie's are 'primary'.

      Returns AxisGroup

    • Returns the size of a bubble chart's largest bubble, 0 to 300 percent of Excel's default, or null for a series that is not a bubble's.

      Returns number | null

    • Returns the formula for a bubble series' sizes, or null if the series states none.

      Returns string | null

    • 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 the series' trendline at index, from 0, or null where it has none there.

      Parameters

      • index: number

      Returns IChart.ITrendline | null

    • Returns how the series is drawn, by the names of IChart.Type. The same as IChart.getChartType except in a combo, or where series of one group differ in markers.

      Returns string

    • Returns one dimension of the series as drawn, each point as text (Office Scripts' getDimensionValues): the categories, the values, a scatter's x or y values, or a bubble's sizes.

      Parameters

      Returns string[]

    • Returns the drop lines of the series' group: a line, area or stock chart's. Their setters throw ExpectedError on another series.

      Returns IChart.ILines

    • Returns how far a pie's or doughnut's slices are pulled out, as a percentage of the radius; 0 for not at all.

      Returns number

    • Returns the series as Excel's SERIES formula: =SERIES(name, categories, values, order), a bubble's with its sizes fifth. Each part is a reference, a literal ("Total", {1,2,3}), or empty.

      Returns string

    • Returns the gap between clusters of bars, as a percentage of a bar's width; on a line or stock series, the gap between its group's up/down bars; on a pie of pie or bar of pie, the gap between its two plots, as a percentage of the second plot's size. null for another series, and for a line or stock series whose group shows no up/down bars.

      Returns number | null

      Every bar of the series' group shares it: setting it sets the group's.

    • Returns the high-low lines of the series' group: a line or stock chart's. Their setters throw ExpectedError on another series.

      Returns IChart.ILines

    • Returns whether a bar's or bubble's negative points are drawn in the inverse of its fill.

      Returns boolean

    • Returns the series' marker: on a line, scatter or radar series, what each point is drawn as.

      Returns IChart.IMarker

    • 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 how far bars of one cluster overlap, -100 to 100 percent of a bar's width, or null for a series that is not a bar.

      Returns number | null

    • Returns the element this one is part of: a point's series, a gridline's axis, a legend entry's legend. The parts at the top (the title, the legend, the plot area, an axis, a series, a group) are the chart area's; the chart area has none.

      Returns IElement | null

    • Returns where the element is in its chart, as IChart.getElement takes it.

      Returns string

      A path is its parts' names joined by /, and does not change while the part is there:

      • chartArea, title, legend, legend/entries/<n>, plotArea, dataTable, and dataLabels (every series' at once);
      • axes/<primary|secondary>/<category|value|series>, and an axis's …/title, …/majorGridlines and …/minorGridlines;
      • series/<key>, and a series' …/marker, …/dataLabels, …/errorBars/<x|y>, …/trendlines/<n>, …/trendlines/<n>/label, …/points/<n>, …/points/<n>/marker and …/points/<n>/dataLabel;
      • groups/<n>, and a group's …/upDownBars, …/hiLoLines, …/dropLines and …/seriesLines.

      A series' key is its index in the file (c:idx), which an edit does not change; its place in the plot order can change. A point, a trendline, a legend entry and a group are named by their place, from 0: when one before it is removed, the path names the one that took its place.

    • Returns the series' place in the plot order, from 0.

      Returns number

    • Returns the series' points, one per value, each with what it states for itself: its fill, line, marker, explosion and label.

      Returns readonly IChart.IPoint[]

    • Returns the indexes of the points in a pie of pie's or bar of pie's second plot, whatever chose them; empty for another series.

      Returns number[]

      VBA's Point.SecondaryPlot, for every point at once.

    • Returns the size of a pie of pie's or bar of pie's second plot, as a percentage of the first pie's, or null for another series.

      Returns number | null

    • Returns the series lines of the series' group: stacked or 100% stacked bars', or a pie of pie's. Their setters throw ExpectedError on another series.

      Returns IChart.ILines

    • Returns whether a bubble chart draws a bubble for a negative size, as large as its magnitude, or null for a series that is not a bubble's.

      Returns boolean | null

    • Returns whether a line or scatter series is drawn as a curve through its points.

      Returns boolean

    • Returns how a pie of pie or bar of pie chooses the points of its second plot, or null for another series. Excel's automatic split, the last third of the points, reads as by position.

      Returns SplitType | null

    • Returns what a pie of pie or bar of pie splits its points by: how many of the last go to the second plot, or the value or percentage of the total below which they do. null for a split by hand, and for another series.

      Returns number | null

    • Returns what the series is drawn with: the fill of its bars, areas or slices and its line.

      Returns IShapeStyle

      Reads resolve to the series' automatic color where it states none; setFill(null) hands the fill back to it.

    • Returns the series' trendlines, in the order the legend lists them.

      Returns readonly IChart.ITrendline[]

      A trendline is named by its place in the series: after one before it is deleted, a trendline held from earlier names the one that took its place, as in Office Scripts.

    • Returns the up/down bars of the series' group: a line or stock chart's. Their setters throw ExpectedError on another series.

      Returns IChart.IUpDownBars

    • 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 whether the series' group colors each point differently, as a pie does.

      Returns boolean

    • Returns the error bars of the series' x values: a scatter's or bubble's only. Their setters throw ExpectedError on another series.

      Returns IChart.IErrorBars

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

      Returns boolean

    • Sets the size of a bubble chart's largest bubble, 0 to 300 percent of Excel's default, for the series' whole group. The bubbles pad the axes in proportion.

      Parameters

      Returns this

      ExpectedError on a series that is not a bubble's, and for a scale outside that.

    • Draws the series as another type, moving it to the group of that type, as Excel does: on its own axes where the type can share them, else on the other pair or new secondary axes. The series is drawn in its own color as a new series of the type is.

      Parameters

      Returns this

      Bubble and 3-D types turn every series of the chart into that type. A stock chart's series given another type leaves the stock group, on the other axes.

      ExpectedError for a stock type, which Excel gives no series, and for a 3-D form, a surface or a 2016 type, which take the whole chart (IChart.setChartType).

    • Pulls a pie's or doughnut's slices out by a percentage of the radius; 0 puts them back.

      Parameters

      Returns this

      ExpectedError on a series that is not a pie's or doughnut's, as Excel refuses it.

    • Sets the series from a SERIES formula (VBA's Series.Formula): its name, categories, values, place in the plot order (from 1) and, for a bubble, its sizes.

      Parameters

      Returns this

      ExpectedError for text that is not a SERIES formula.

    • Sets the gap between clusters of bars, 0 to 500, for the series' whole group; on a line or stock series, the gap between its group's up/down bars; on a pie of pie or bar of pie, the gap between its plots.

      Parameters

      Returns this

      ExpectedError on a series that is not a bar or an of-pie, and on a line or stock series whose group shows no up/down bars (see IChart.IUpDownBars.setGapWidth).

    • Sets whether a bar's or bubble's negative points are drawn in the inverse of its fill.

      Parameters

      Returns this

      ExpectedError on a series that is not a bar's or bubble's, as Excel refuses it.

    • Moves the series to a place in the plot order, from 0: the order it is listed, stacked and drawn in. Its group's series are relisted in that order.

      Parameters

      Returns this

    • Puts these points, by index, in a pie of pie's or bar of pie's second plot and the others in the first: a split by hand.

      Parameters

      Returns this

      ExpectedError on a series that is not a pie of pie or bar of pie, and for an index that is not a point's.

    • Sets the size of a pie of pie's or bar of pie's second plot, 5 to 200 percent of the first pie's.

      Parameters

      Returns this

      ExpectedError on a series that is not a pie of pie or bar of pie, and for a size outside that.

    • Sets whether a bubble chart draws a bubble for a negative size, for the series' whole group.

      Parameters

      Returns this

      ExpectedError on a series that is not a bubble's.

    • Sets whether a line or scatter series is drawn as a curve.

      Parameters

      Returns this

      ExpectedError on a series that is not a line's or scatter's, as Excel refuses it.

    • Sets how a pie of pie or bar of pie chooses the points of its second plot. As in Excel, a split by value starts from a value of 1, and one by position or by hand from the points the second plot has now.

      Parameters

      Returns this

      ExpectedError on a series that is not a pie of pie or bar of pie.

    • Sets what a pie of pie or bar of pie splits its points by; on Excel's automatic split, it becomes a split by position.

      Parameters

      Returns this

      ExpectedError on a series that is not a pie of pie or bar of pie, on a split by hand, and for a negative value.

    • Sets whether the series' group colors each point differently. A single series given it takes a point per value in the chart's colors, as Excel does; a pie denied it is drawn in one color.

      Parameters

      Returns this

    • Sets the categories the values are plotted against — a scatter or bubble series' x values — as cells, a formula naming them, or an array; null for none, which plots against 1, 2, 3…

      Parameters

      Returns this