ts-pptx

Appearance

Interface: ChartPropsBase ​

Extended by ​

Properties ​

chartArea? ​

optional chartArea?: ChartAreaProps

PowerPoint: Format Chart Area (Fill & Border/Line)

chartColors? ​

optional chartColors?: string[]

Series colours, cycled: series (or, on a pie/doughnut, data point) n takes chartColors[n % chartColors.length], so a shorter list repeats rather than running out.

Omitting it, or passing an empty array, both mean the same thing — the built-in default palette for the chart type. Two spellings of "I named no colours"; there is no third state that suppresses the fills.

chartColorsOpacity? ​

optional chartColorsOpacity?: number

Series fill opacity, as a percentage from 0 to 100.

0 means what it says: a fully transparent fill, so the series is invisible. That is a deliberate meaning, not a shorthand for "unset"; leave the option out for an opaque fill. A value outside 0-100 clamps with a warning, and NaN throws.

Example ​

ts
50 // 50% opaque

dataBorder? ​

optional dataBorder?: StrokeProps

displayBlanksAs? ​

optional displayBlanksAs?: "zero" | "gap" | "span"

What a plot draws where a value is missing (ST_DispBlanksAs).

Default ​

ts
'gap'

invertedColors? ​

optional invertedColors?: string[]

lang? ​

optional lang?: string

layout? ​

optional layout?: PositionProps

leaderLineColor? ​

optional leaderLineColor?: string

Leader line color (pie/doughnut data labels). Requires showLeaderLines: true. When omitted, PowerPoint applies its automatic leader-line color.

Example ​

ts
'FF0000' // red leader lines

leaderLineSize? ​

optional leaderLineSize?: number

Leader line width, in points (pie/doughnut data labels). Requires showLeaderLines: true.

Default ​

ts
0.75

Example ​

ts
1.5

plotArea? ​

optional plotArea?: ChartPropsFillLine

PowerPoint: Format Plot Area (Fill & Border/Line)

seriesOptions? ​

optional seriesOptions?: ChartSeriesOpts[]

Per-series style overrides.

Element at index N applies to the Nth series of the chart — the same number the series carries in <c:idx>/<c:order>. For most plots that is its position in data; on a combo it counts across every subchart in order, so a bar(2) + line(1) combo reaches the line at index 2. A scatter or bubble series counts one lower than its position, because the X row in front of it is not a series: seriesOptions[0] styles data[1]. Missing indices or unset fields fall back to the chart-level option.

Not every field reaches every plot, and a stated field that cannot be resolved warns (chart/option-not-supported) naming itself rather than being dropped in silence:

  • color reaches every plot that colours series: bar, bar3d, area, line, radar, scatter, bubble, bubble3d, and (as the volume bar and the close marker) stock.
  • lineSize reaches only a series that strokes itself: line, radar, scatter, bubble and bubble3d. A bar or an area takes its outline from dataBorder; a stock price series draws no line at all.
  • the dataLabel* fields need a per-series <c:dLbls>, which the category-axis family and scatter emit. A bubble chart's label block is chart-level, and dataLabelFormatCode in particular has no referent on scatter, whose label builders emit no number format.
  • pie, doughnut and surface read nothing: a pie colours points and a surface colours bands, so a per-series override has no referent even in principle.

shadow? ​

optional shadow?: ShadowProps

showBubbleSize? ​

optional showBubbleSize?: boolean

Show each bubble's size value as a data label (bubble / bubble3D charts only). Has no effect on other chart types.

Default ​

ts
false

showLabel? ​

optional showLabel?: boolean

Enable data labels, with a meaning that is overloaded per plot type — it is not a plain duplicate of ChartPropsBase.showValue:

  • pie / doughnut: shows the category name (c:showCatName);
  • scatter: turns on the labels ChartPropsDataLabel.dataLabelFormatScatter describes, and shows nothing without it: 'XY' shows both the value and the category name, and 'custom'/'customXY' show each point's label text;
  • chartEx (waterfall/funnel/…): OR-combined with showValue to show the value label.

For the common "show the numeric value" case on standard plots, prefer showValue.

Default ​

ts
false

showLeaderLines? ​

optional showLeaderLines?: boolean

showLegend? ​

optional showLegend?: boolean

Default ​

ts
false

showPercent? ​

optional showPercent?: boolean

Default ​

ts
false

showSerName? ​

optional showSerName?: boolean

Default ​

ts
false

showTitle? ​

optional showTitle?: boolean

Default ​

ts
false

showValue? ​

optional showValue?: boolean

Default ​

ts
false

v3DPerspective? ​

optional v3DPerspective?: number

3D Perspecitve

  • range: 0-120

Default ​

ts
30

v3DRAngAx? ​

optional v3DRAngAx?: boolean

Right Angle Axes

  • Shows chart from first-person perspective
  • Overrides v3DPerspective when true
  • PowerPoint: Chart Options > 3-D Rotation

Default ​

ts
false

v3DRotX? ​

optional v3DRotX?: number

X Rotation

  • PowerPoint: Chart Options > 3-D Rotation
  • range: 0-359.9

Default ​

ts
30

v3DRotY? ​

optional v3DRotY?: number

Y Rotation

  • range: 0-359.9

Default ​

ts
30