SheetXL - v1.0.2
    Preparing search index...

    Interface IChartGroup

    A chart group: the series drawn one way against one pair of axes, and the options they share (VBA's ChartGroup). Office Scripts has no groups; its per-series options set the group's.

    interface IChartGroup {
        isIChartGroup: true;
        getAxisGroup(): AxisGroup;
        getChart(): IChart;
        getChartType(): string;
        getDropLines(): IChart.ILines;
        getElementType(): IChart.ElementType;
        getGapWidth(): number | null;
        getHiLoLines(): IChart.ILines;
        getIndex(): number;
        getOverlap(): number | null;
        getParent(): IElement | null;
        getPath(): string;
        getSeries(): readonly IChart.ISeries[];
        getSeriesLines(): IChart.ILines;
        getStyle?(): IShapeStyle;
        getUpDownBars(): IChart.IUpDownBars;
        getVaryByCategories(): boolean;
        setVaryByCategories(
            vary: boolean,
            options?: ITransaction.OperationOptions,
        ): this;
    }

    Hierarchy (View Summary)

    Index
    isIChartGroup
    getAxisGroup getChart getChartType getDropLines getElementType getGapWidth getHiLoLines getIndex getOverlap getParent getPath getSeries getSeriesLines getStyle? getUpDownBars getVaryByCategories setVaryByCategories
    isIChartGroup: true

    For runtime type checking.

    • Returns the axes the group draws against; a pie's are 'primary'.

      Returns AxisGroup

    • Returns how the group's series are drawn, by the names of IChart.Type: its first series' type.

      Returns string

    • Returns the gap between clusters of bars, or null where the group has none.

      Returns number | null

    • Returns the group's place among the chart's groups, from 0.

      Returns number

    • Returns how far the group's bars overlap, or null where it has none.

      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 group's series lines: stacked bars' or a pie of pie's.

      Returns IChart.ILines

    • Returns whether the group colors each point differently.

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Properties
    Methods