Class: ChartPlotGroup
One plot group of a chart's plot area (c:barChart, c:lineChart, c:pieChart, …): the series it plots and what it sets on all of them. Each accessor reads null (or false for an element that is either there or not) where the group does not state it, including on a plot type whose schema has no such element.
Constructors
Constructor
new ChartPlotGroup(
group,part):ChartPlotGroup
Parameters
| Parameter | Type | Description |
|---|---|---|
group | Element | - |
part | Part | The owning chart's OPC part, so markDirty can reach it from element_. |
Returns
ChartPlotGroup
Accessors
axisIds
Get Signature
get axisIds():
number[]
The ids of the axes this group plots against (c:axId), as ChartAxis.id reads them: a combo's group on the secondary axes names the secondary pair. Empty for a pie or a doughnut.
Returns
number[]
barDirection
Get Signature
get barDirection():
string|null
A bar group's direction (c:barDir): bar (horizontal) or col (vertical).
Returns
string | null
element_
Get Signature
get element_():
Element
Escape hatch: the underlying plot-group element. After mutating it call markDirty, or save() writes the original bytes.
Returns
Element
firstSliceAngle
Get Signature
get firstSliceAngle():
number|null
The angle of a pie's first slice, 0 to 360 degrees (c:firstSliceAng).
Returns
number | null
gapDepthPct
Get Signature
get gapDepthPct():
number|null
The depth gap of a 3-D bar group, as a percentage (c:gapDepth).
Returns
number | null
gapWidthPct
Get Signature
get gapWidthPct():
number|null
The gap between bar clusters as a percentage of a bar's width (c:gapWidth).
Returns
number | null
grouping
Get Signature
get grouping():
string|null
How the series stack (c:grouping): clustered, stacked, percentStacked or standard.
Returns
string | null
holeSizePct
Get Signature
get holeSizePct():
number|null
A doughnut's hole, 10 to 90 percent of its size (c:holeSize).
Returns
number | null
overlapPct
Get Signature
get overlapPct():
number|null
How far bars in a cluster overlap, -100 to 100 percent (c:overlap).
Returns
number | null
radarStyle
Get Signature
get radarStyle():
string|null
A radar's style (c:radarStyle): standard, marker or filled.
Returns
string | null
series
Get Signature
get series():
ChartSeries[]
The series this group plots (c:ser), in document order.
Returns
seriesLines
Get Signature
get seriesLines():
boolean
Whether stacked bars are joined by series lines (c:serLines).
Returns
boolean
seriesLinesLine
Get Signature
get seriesLinesLine():
ChartLine|null
The series lines' stroke (c:serLines/c:spPr/a:ln), or null when they state none.
Returns
ChartLine | null
shape
Get Signature
get shape():
string|null
The group-wide 3-D bar shape (c:shape); a series can state its own (ChartSeries.shape).
Returns
string | null
type
Get Signature
get type():
string
The plot type, the element's local name less Chart: bar, line, bar3D, doughnut, …
Returns
string
upDownBars
Get Signature
get upDownBars():
boolean
Whether a line or stock group draws up/down bars (c:upDownBars).
Returns
boolean
wireframe
Get Signature
get wireframe():
boolean|null
Whether a surface is drawn as a wireframe (c:wireframe).
Returns
boolean | null
Methods
markDirty()
markDirty():
void
Mark the owning chart part dirty so save() reserializes it. Call after mutating element_.
Returns
void