@shbernal/pptxgenjs

---

@shbernal/pptxgenjs / index / ChartOptsInternal

Interface: ChartOptsInternal

Defined in: core-interfaces.ts:2902

Extends

• ChartOpts

Properties

_type?

optional _type?: ChartType | ChartMulti[]

Defined in: core-interfaces.ts:2903

---

align?

optional align?: HAlign

Defined in: core-interfaces.ts:542

Horizontal alignment

Default

'left'

Inherited from

ChartOpts.align

---

altText?

optional altText?: string

Defined in: core-interfaces.ts:2889

Alt Text value ("How would you describe this object and its contents to someone who is blind?")

• PowerPoint: [right-click on a chart] > "Edit Alt Text..."

Inherited from

ChartOpts.altText

---

axisPos?

optional axisPos?: "r" | "b" | "l" | "t"

Defined in: core-interfaces.ts:2389

Axis position

Inherited from

ChartOpts.axisPos

---

bar3DShape?

optional bar3DShape?: string

Defined in: core-interfaces.ts:2636

Inherited from

ChartOpts.bar3DShape

---

barDir?

optional barDir?: string

Defined in: core-interfaces.ts:2637

Inherited from

ChartOpts.barDir

---

barGapDepthPct?

optional barGapDepthPct?: number

Defined in: core-interfaces.ts:2638

Inherited from

ChartOpts.barGapDepthPct

---

barGapWidthPct?

optional barGapWidthPct?: number

Defined in: core-interfaces.ts:2645

MS-PPT > Format chart > Format Data Point > Series Options > "Gap Width"

• width (percent)
• range: 0-500

Default

150

Inherited from

ChartOpts.barGapWidthPct

---

barGrouping?

optional barGrouping?: string

Defined in: core-interfaces.ts:2646

Inherited from

ChartOpts.barGrouping

---

barOverlapPct?

optional barOverlapPct?: number

Defined in: core-interfaces.ts:2653

MS-PPT > Format chart > Format Data Point > Series Options > "Series Overlap"

• overlap (percent)
• range: -100-100

Default

0

Inherited from

ChartOpts.barOverlapPct

---

barSeriesLine?

optional barSeriesLine?: boolean | OptsChartGridLine

Defined in: core-interfaces.ts:2667

Draw connector lines between data points across stacked bar/column series ("Series Lines" in PowerPoint). Emits <c:serLines> in the bar chart.

• true uses PowerPoint's automatic line styling.
• An OptsChartGridLine object customizes color/size/style/cap.
• Omit (or pass an object with style: 'none') to disable.

Bar (bar) charts only; ignored for 3D bar charts.

Default

undefined

Examples

true

{ color: '777777', size: 1, style: 'dash' }

Inherited from

ChartOpts.barSeriesLine

---

bold?

optional bold?: boolean

Defined in: core-interfaces.ts:547

Bold style

Default

false

Inherited from

ChartOpts.bold

---

breakLine?

optional breakLine?: boolean

Defined in: core-interfaces.ts:552

Add a line-break

Default

false

Inherited from

ChartOpts.breakLine

---

bullet?

optional bullet?: boolean | { characterCode?: string; color?: string; fontFace?: string; image?: { data?: string; path?: string; }; indent?: number; numberStartAt?: number; numberType?: "alphaLcParenBoth" | "alphaLcParenR" | "alphaLcPeriod" | "alphaUcParenBoth" | "alphaUcParenR" | "alphaUcPeriod" | "arabicParenBoth" | "arabicParenR" | "arabicPeriod" | "arabicPlain" | "romanLcParenBoth" | "romanLcParenR" | "romanLcPeriod" | "romanUcParenBoth" | "romanUcParenR" | "romanUcPeriod"; size?: number; type?: "number" | "bullet"; }

Defined in: core-interfaces.ts:567

Add standard or custom bullet

• use true for standard bullet
• pass object options for custom bullet

Union Members

boolean

---

Type Literal

{ characterCode?: string; color?: string; fontFace?: string; image?: { data?: string; path?: string; }; indent?: number; numberStartAt?: number; numberType?: "alphaLcParenBoth" | "alphaLcParenR" | "alphaLcPeriod" | "alphaUcParenBoth" | "alphaUcParenR" | "alphaUcPeriod" | "arabicParenBoth" | "arabicParenR" | "arabicPeriod" | "arabicPlain" | "romanLcParenBoth" | "romanLcParenR" | "romanLcPeriod" | "romanUcParenBoth" | "romanUcParenR" | "romanUcPeriod"; size?: number; type?: "number" | "bullet"; }

characterCode?

optional characterCode?: string

Bullet character code (unicode)

Example

'25BA' // 'BLACK RIGHT-POINTING POINTER' (U+25BA)

color?

optional color?: string

Bullet glyph color (separate from the text run color)

Example

'FF0000' // red bullet

fontFace?

optional fontFace?: string

Bullet glyph font typeface (<a:buFont/>), e.g. for symbol-font bullets

Example

'Wingdings' // render `characterCode` using the Wingdings font

image?

optional image?: object

Image to use as the bullet glyph ("picture bullet", <a:buBlip>)

• supply an image path (filesystem/URL) or base64 data (same forms as addImage())
• raster formats (PNG/JPG/GIF) and SVG are supported; use size to scale relative to the text height
• SVG bullets embed a PNG preview plus the SVG (the same dual-rel handling as addImage())
• takes precedence over type/characterCode when set

Examples

image: { path: 'images/star.png' }

image: { data: 'image/png;base64,iVBOR...' }

image: { path: 'images/star.svg' }

image.data?

optional data?: string

image.path?

optional path?: string

indent?

optional indent?: number

Indentation (space between bullet and text) (points)

Default

27 // DEF_BULLET_MARGIN

Example

10 // Indents text 10 points from bullet

numberStartAt?

optional numberStartAt?: number

Number bullets start at

Default

1

Example

10 // numbered bullets start with 10

numberType?

optional numberType?: "alphaLcParenBoth" | "alphaLcParenR" | "alphaLcPeriod" | "alphaUcParenBoth" | "alphaUcParenR" | "alphaUcPeriod" | "arabicParenBoth" | "arabicParenR" | "arabicPeriod" | "arabicPlain" | "romanLcParenBoth" | "romanLcParenR" | "romanLcPeriod" | "romanUcParenBoth" | "romanUcParenR" | "romanUcPeriod"

Number type

Example

'romanLcParenR' // roman numerals lower-case with paranthesis right

size?

optional size?: number

Bullet glyph size as a percentage of the run's text size (25–400)

Default

100

Example

80 // bullet glyph is 80% of the text size

type?

optional type?: "number" | "bullet"

Bullet type

Default

bullet

Default

false

Inherited from

ChartOpts.bullet

---

cap?

optional cap?: LineCap

Defined in: core-interfaces.ts:2343

MS-PPT > Chart format > Format Major Gridlines > Line > Cap type

• line cap type

Default

flat

Inherited from

ChartOpts.cap

---

caps?

optional caps?: "small" | "all" | "none"

Defined in: core-interfaces.ts:659

Text capitalization

• 'all' = ALL CAPS
• 'small' = Small Caps
• 'none' = no override (default)
• PowerPoint: Font > Effects > All Caps / Small Caps

Inherited from

ChartOpts.caps

---

catAxes?

optional catAxes?: ChartPropsAxisCat[]

Defined in: core-interfaces.ts:2493

Multi-Chart prop: array of cat axes

Inherited from

ChartOpts.catAxes

---

catAxisBaseTimeUnit?

optional catAxisBaseTimeUnit?: string

Defined in: core-interfaces.ts:2494

Inherited from

ChartOpts.catAxisBaseTimeUnit

---

catAxisCrossesAt?

optional catAxisCrossesAt?: number | "autoZero"

Defined in: core-interfaces.ts:2495

Inherited from

ChartOpts.catAxisCrossesAt

---

catAxisHidden?

optional catAxisHidden?: boolean

Defined in: core-interfaces.ts:2496

Inherited from

ChartOpts.catAxisHidden

---

catAxisLabelColor?

optional catAxisLabelColor?: string

Defined in: core-interfaces.ts:2497

Inherited from

ChartOpts.catAxisLabelColor

---

catAxisLabelFontBold?

optional catAxisLabelFontBold?: boolean

Defined in: core-interfaces.ts:2498

Inherited from

ChartOpts.catAxisLabelFontBold

---

catAxisLabelFontFace?

optional catAxisLabelFontFace?: string

Defined in: core-interfaces.ts:2499

Inherited from

ChartOpts.catAxisLabelFontFace

---

catAxisLabelFontItalic?

optional catAxisLabelFontItalic?: boolean

Defined in: core-interfaces.ts:2500

Inherited from

ChartOpts.catAxisLabelFontItalic

---

catAxisLabelFontSize?

optional catAxisLabelFontSize?: number

Defined in: core-interfaces.ts:2501

Inherited from

ChartOpts.catAxisLabelFontSize

---

catAxisLabelFormatCode?

optional catAxisLabelFormatCode?: string

Defined in: core-interfaces.ts:2508

Number format code for the category (X) axis labels on scatter and bubble charts. Falls back to valAxisLabelFormatCode when not set.

• Example: '0.00', '#,##0', 'mmm yyyy'
• PowerPoint: Format Axis > Number > Format Code

Inherited from

ChartOpts.catAxisLabelFormatCode

---

catAxisLabelFrequency?

optional catAxisLabelFrequency?: string

Defined in: core-interfaces.ts:2509

Inherited from

ChartOpts.catAxisLabelFrequency

---

catAxisLabelPos?

optional catAxisLabelPos?: "none" | "high" | "low" | "nextTo"

Defined in: core-interfaces.ts:2510

Inherited from

ChartOpts.catAxisLabelPos

---

catAxisLabelRotate?

optional catAxisLabelRotate?: number

Defined in: core-interfaces.ts:2511

Inherited from

ChartOpts.catAxisLabelRotate

---

catAxisLineColor?

optional catAxisLineColor?: string

Defined in: core-interfaces.ts:2512

Inherited from

ChartOpts.catAxisLineColor

---

catAxisLineShow?

optional catAxisLineShow?: boolean

Defined in: core-interfaces.ts:2513

Inherited from

ChartOpts.catAxisLineShow

---

catAxisLineSize?

optional catAxisLineSize?: number

Defined in: core-interfaces.ts:2514

Inherited from

ChartOpts.catAxisLineSize

---

catAxisLineStyle?

optional catAxisLineStyle?: "dash" | "solid" | "dot"

Defined in: core-interfaces.ts:2515

Inherited from

ChartOpts.catAxisLineStyle

---

catAxisMajorTickMark?

optional catAxisMajorTickMark?: ChartAxisTickMark

Defined in: core-interfaces.ts:2516

Inherited from

ChartOpts.catAxisMajorTickMark

---

catAxisMajorTimeUnit?

optional catAxisMajorTimeUnit?: string

Defined in: core-interfaces.ts:2517

Inherited from

ChartOpts.catAxisMajorTimeUnit

---

catAxisMajorUnit?

optional catAxisMajorUnit?: number

Defined in: core-interfaces.ts:2518

Inherited from

ChartOpts.catAxisMajorUnit

---

catAxisMaxVal?

optional catAxisMaxVal?: number

Defined in: core-interfaces.ts:2519

Inherited from

ChartOpts.catAxisMaxVal

---

catAxisMinorTickMark?

optional catAxisMinorTickMark?: ChartAxisTickMark

Defined in: core-interfaces.ts:2520

Inherited from

ChartOpts.catAxisMinorTickMark

---

catAxisMinorTimeUnit?

optional catAxisMinorTimeUnit?: string

Defined in: core-interfaces.ts:2521

Inherited from

ChartOpts.catAxisMinorTimeUnit

---

catAxisMinorUnit?

optional catAxisMinorUnit?: number

Defined in: core-interfaces.ts:2522

Inherited from

ChartOpts.catAxisMinorUnit

---

catAxisMinVal?

optional catAxisMinVal?: number

Defined in: core-interfaces.ts:2523

Inherited from

ChartOpts.catAxisMinVal

---

catAxisMultiLevelLabels?

optional catAxisMultiLevelLabels?: boolean

Defined in: core-interfaces.ts:2524

Inherited from

ChartOpts.catAxisMultiLevelLabels

---

catAxisOrientation?

optional catAxisOrientation?: "minMax" | "maxMin"

Defined in: core-interfaces.ts:2525

Inherited from

ChartOpts.catAxisOrientation

---

catAxisTitle?

optional catAxisTitle?: string

Defined in: core-interfaces.ts:2526

Inherited from

ChartOpts.catAxisTitle

---

catAxisTitleColor?

optional catAxisTitleColor?: string

Defined in: core-interfaces.ts:2527

Inherited from

ChartOpts.catAxisTitleColor

---

catAxisTitleFontFace?

optional catAxisTitleFontFace?: string

Defined in: core-interfaces.ts:2528

Inherited from

ChartOpts.catAxisTitleFontFace

---

catAxisTitleFontSize?

optional catAxisTitleFontSize?: number

Defined in: core-interfaces.ts:2529

Inherited from

ChartOpts.catAxisTitleFontSize

---

catAxisTitleRotate?

optional catAxisTitleRotate?: number

Defined in: core-interfaces.ts:2530

Inherited from

ChartOpts.catAxisTitleRotate

---

catGridLine?

optional catGridLine?: OptsChartGridLine

Defined in: core-interfaces.ts:2531

Inherited from

ChartOpts.catGridLine

---

catLabelFormatCode?

optional catLabelFormatCode?: string

Defined in: core-interfaces.ts:2532

Inherited from

ChartOpts.catLabelFormatCode

---

chartArea?

optional chartArea?: ChartAreaProps

Defined in: core-interfaces.ts:2476

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

Inherited from

ChartOpts.chartArea

---

chartColors?

optional chartColors?: string[]

Defined in: core-interfaces.ts:2390

Inherited from

ChartOpts.chartColors

---

chartColorsOpacity?

optional chartColorsOpacity?: number

Defined in: core-interfaces.ts:2395

opacity (0 - 100)

Example

50 // 50% opaque

Inherited from

ChartOpts.chartColorsOpacity

---

color?

optional color?: string

Defined in: core-interfaces.ts:667

Text color

• HexColor or ThemeColor
• MS-PPT > Format Shape > Text Options > Text Fill & Outline > Text Fill > Color

Examples

'FF0000' // hex color (red)

pptx.SchemeColor.text1 // Theme color (Text1)

Inherited from

ChartOpts.color

---

dataBorder?

optional dataBorder?: BorderProps

Defined in: core-interfaces.ts:2396

Inherited from

ChartOpts.dataBorder

---

dataLabelBkgrdColors?

optional dataLabelBkgrdColors?: boolean

Defined in: core-interfaces.ts:2790

Inherited from

ChartOpts.dataLabelBkgrdColors

---

dataLabelColor?

optional dataLabelColor?: string

Defined in: core-interfaces.ts:2791

Inherited from

ChartOpts.dataLabelColor

---

dataLabelFontBold?

optional dataLabelFontBold?: boolean

Defined in: core-interfaces.ts:2792

Inherited from

ChartOpts.dataLabelFontBold

---

dataLabelFontFace?

optional dataLabelFontFace?: string

Defined in: core-interfaces.ts:2793

Inherited from

ChartOpts.dataLabelFontFace

---

dataLabelFontItalic?

optional dataLabelFontItalic?: boolean

Defined in: core-interfaces.ts:2794

Inherited from

ChartOpts.dataLabelFontItalic

---

dataLabelFontSize?

optional dataLabelFontSize?: number

Defined in: core-interfaces.ts:2795

Inherited from

ChartOpts.dataLabelFontSize

---

dataLabelFormatCode?

optional dataLabelFormatCode?: string

Defined in: core-interfaces.ts:2802

Data label format code

Examples

'#%' // round percent

'0.00%' // shows values as '0.00%'

'$0.00' // shows values as '$0.00'

Inherited from

ChartOpts.dataLabelFormatCode

---

dataLabelFormatScatter?

optional dataLabelFormatScatter?: "custom" | "customXY" | "XY"

Defined in: core-interfaces.ts:2803

Inherited from

ChartOpts.dataLabelFormatScatter

---

dataLabelPosition?

optional dataLabelPosition?: "r" | "b" | "l" | "ctr" | "t" | "bestFit" | "inEnd" | "outEnd"

Defined in: core-interfaces.ts:2804

Inherited from

ChartOpts.dataLabelPosition

---

dataNoEffects?

optional dataNoEffects?: boolean

Defined in: core-interfaces.ts:2670

Inherited from

ChartOpts.dataNoEffects

---

dataTableFontSize?

optional dataTableFontSize?: number

Defined in: core-interfaces.ts:2807

Inherited from

ChartOpts.dataTableFontSize

---

dataTableFormatCode?

optional dataTableFormatCode?: string

Defined in: core-interfaces.ts:2814

Data table format code

Examples

'#%' // round percent

'0.00%' // shows values as '0.00%'

'$0.00' // shows values as '$0.00'

Inherited from

ChartOpts.dataTableFormatCode

---

displayBlanksAs?

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

Defined in: core-interfaces.ts:2397

Inherited from

ChartOpts.displayBlanksAs

---

firstSliceAng?

optional firstSliceAng?: number

Defined in: core-interfaces.ts:2739

MS-PPT > Format chart > Format Data Series > Series Options > "Angle of first slice"

• angle (degrees)
• range: 0-359

Default

0

Inherited from

ChartOpts.firstSliceAng

---

fontFace?

optional fontFace?: string

Defined in: core-interfaces.ts:677

Font face name

Applied to the Latin (<a:latin>) and complex-script (<a:cs>) font slots, matching how PowerPoint writes a font picked from the UI. The East Asian slot (<a:ea>) is left to inherit from the theme unless fontFaceEA is set — forcing a Latin-only face into the East Asian slot duplicates/ghosts text in Office 365.

Example

'Arial' // Arial font

Inherited from

ChartOpts.fontFace

---

fontFaceEA?

optional fontFaceEA?: string

Defined in: core-interfaces.ts:685

East Asian font face name (<a:ea> slot), used to render CJK (Chinese/Japanese/Korean) glyphs

Set this when the East Asian font differs from fontFace. When omitted, <a:ea> inherits the theme East Asian font, which is what PowerPoint does for Latin fonts.

Example

'微軟正黑體' // render East Asian glyphs with Microsoft JhengHei

Inherited from

ChartOpts.fontFaceEA

---

fontSize?

optional fontSize?: number

Defined in: core-interfaces.ts:690

Font size

Example

12 // Font size 12

Inherited from

ChartOpts.fontSize

---

h?

optional h?: Coord

Defined in: core-interfaces.ts:61

Height

• inches or percentage

Examples

10.25 // height in inches

'75%' // height as percentage of slide size

Inherited from

ChartOpts.h

---

highlight?

optional highlight?: string

Defined in: core-interfaces.ts:695

Text highlight color (hex format)

Example

'FFFF00' // yellow

Inherited from

ChartOpts.highlight

---

holeSize?

optional holeSize?: number

Defined in: core-interfaces.ts:2671

Inherited from

ChartOpts.holeSize

---

invertedColors?

optional invertedColors?: string[]

Defined in: core-interfaces.ts:2398

Inherited from

ChartOpts.invertedColors

---

italic?

optional italic?: boolean

Defined in: core-interfaces.ts:700

italic style

Default

false

Inherited from

ChartOpts.italic

---

lang?

optional lang?: string

Defined in: core-interfaces.ts:2399

language

• ISO 639-1 standard language code

Default

'en-US' // english US

Example

'fr-CA' // french Canadian

Inherited from

ChartOpts.lang

---

layout?

optional layout?: PositionProps

Defined in: core-interfaces.ts:2400

Inherited from

ChartOpts.layout

---

leaderLineColor?

optional leaderLineColor?: string

Defined in: core-interfaces.ts:2418

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

Example

'FF0000' // red leader lines

Inherited from

ChartOpts.leaderLineColor

---

leaderLineSize?

optional leaderLineSize?: number

Defined in: core-interfaces.ts:2424

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

Default

0.75

Example

1.5

Inherited from

ChartOpts.leaderLineSize

---

legendColor?

optional legendColor?: string

Defined in: core-interfaces.ts:2826

Inherited from

ChartOpts.legendColor

---

legendFontFace?

optional legendFontFace?: string

Defined in: core-interfaces.ts:2827

Inherited from

ChartOpts.legendFontFace

---

legendFontSize?

optional legendFontSize?: number

Defined in: core-interfaces.ts:2828

Inherited from

ChartOpts.legendFontSize

---

legendLayout?

optional legendLayout?: PositionProps

Defined in: core-interfaces.ts:2842

Manual legend placement within the chart area.

Each of x/y/w/h is a fraction (0-1) of the chart's width/height. x/y position the legend's top-left corner relative to the chart edge; w/h set its size. Each axis is independent: provide only x to move the legend horizontally while leaving vertical placement and size automatic. Setting this overrides the automatic placement implied by legendPos.

Has no effect unless showLegend is true.

Example

{ x: 0.7, y: 0.3, w: 0.25, h: 0.4 }

Inherited from

ChartOpts.legendLayout

---

legendPos?

optional legendPos?: "r" | "b" | "tr" | "l" | "t"

Defined in: core-interfaces.ts:2843

Inherited from

ChartOpts.legendPos

---

lineCap?

optional lineCap?: LineCap

Defined in: core-interfaces.ts:2679

MS-PPT > Chart format > Format Data Series > Line > Cap type

• line cap type

Default

flat

Inherited from

ChartOpts.lineCap

---

lineDash?

optional lineDash?: ChartLineDash

Defined in: core-interfaces.ts:2685

MS-PPT > Chart format > Format Data Series > Line > Dash type (chart-level default)

• applies to every series that has no entry in lineDashValues

Default

solid

Inherited from

ChartOpts.lineDash

---

lineDashValues?

optional lineDashValues?: ChartLineDash[]

Defined in: core-interfaces.ts:2691

Per-series dash type overrides; index matches the series order in the data array.

• entries shorter than the series count fall back to lineDash
• example: ['solid', 'dash', 'lgDash'] gives each series its own dash pattern

Inherited from

ChartOpts.lineDashValues

---

lineDataSymbol?

optional lineDataSymbol?: "none" | "square" | "triangle" | "circle" | "dash" | "diamond" | "dot"

Defined in: core-interfaces.ts:2697

MS-PPT > Chart format > Format Data Series > Marker Options > Built-in > Type

• marker type

Default

circle

Inherited from

ChartOpts.lineDataSymbol

---

lineDataSymbolLineColor?

optional lineDataSymbolLineColor?: string

Defined in: core-interfaces.ts:2703

MS-PPT > Chart format > Format Data Series > [Marker Options] > Border > Color

• border color

Default

circle

Inherited from

ChartOpts.lineDataSymbolLineColor

---

lineDataSymbolLineSize?

optional lineDataSymbolLineSize?: number

Defined in: core-interfaces.ts:2709

MS-PPT > Chart format > Format Data Series > [Marker Options] > Border > Width

• border width (points)

Default

0.75

Inherited from

ChartOpts.lineDataSymbolLineSize

---

lineDataSymbolSize?

optional lineDataSymbolSize?: number

Defined in: core-interfaces.ts:2716

MS-PPT > Chart format > Format Data Series > Marker Options > Built-in > Size

• marker size
• range: 2-72

Default

6

Inherited from

ChartOpts.lineDataSymbolSize

---

lineSize?

optional lineSize?: number

Defined in: core-interfaces.ts:2723

MS-PPT > Chart format > Format Data Series > Line > Width

• line width (points)
• range: 0-1584

Default

2

Inherited from

ChartOpts.lineSize

---

lineSmooth?

optional lineSmooth?: boolean

Defined in: core-interfaces.ts:2729

MS-PPT > Chart format > Format Data Series > Line > Smoothed line

• "Smoothed line"

Default

false

Inherited from

ChartOpts.lineSmooth

---

metadata?

optional metadata?: Record<string, string>

Defined in: core-interfaces.ts:2900

Custom chart-level metadata, emitted as a schema-valid extension on the chart space (c:chartSpace/c:extLst) under a stable PptxGenJS vendor GUID.

• Use for round-trippable, machine-readable annotations a consumer wants to travel with the chart (e.g. a source-data id, a generator tag, a semantic role). PowerPoint preserves the extension untouched and ignores it for rendering.
• Keys must be non-empty strings; values must be strings. Invalid entries are dropped with a console warning rather than emitting degenerate XML.

Example

{ sourceId: 'q3-revenue', generator: 'my-deck-tool' }

Inherited from

ChartOpts.metadata

---

objectLock?

optional objectLock?: ObjectLockProps

Defined in: core-interfaces.ts:811

Object lock flags (DrawingML a:spLocks / a:picLocks / a:graphicFrameLocks)

• restrict how the object can be manipulated in PowerPoint (e.g. prevent moving, resizing, or grouping)
• each flag maps 1:1 to the OOXML attribute of the same name; only flags set to true are emitted
• PowerPoint UI: Selection Pane / right-click protections (most locks are honored at edit time, not as a password)
• flags only apply to the object types that support them (see each flag); flags set on an unsupported object type are ignored with a console warning

Examples

{ noMove: true, noResize: true } // pin an object in place

{ noGrp: true } // exclude from grouping

Inherited from

ChartOpts.objectLock

---

objectName?

optional objectName?: string

Defined in: core-interfaces.ts:793

Object name

• used instead of default "Object N" name
• PowerPoint: Home > Arrange > Selection Pane...

Default

'Object 1'

Example

'Antenna Design 9'

Inherited from

ChartOpts.objectName

---

plotArea?

optional plotArea?: ChartPropsFillLine

Defined in: core-interfaces.ts:2480

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

Inherited from

ChartOpts.plotArea

---

radarStyle?

optional radarStyle?: "standard" | "marker" | "radar" | "markers" | "filled"

Defined in: core-interfaces.ts:2747

Radar chart sub-type, named to match the PowerPoint UI ("Radar", "Radar with Markers", "Filled Radar").

Default

radar

Inherited from

ChartOpts.radarStyle

---

secondaryCatAxis?

optional secondaryCatAxis?: boolean

Defined in: core-interfaces.ts:2537

Whether data should use secondary category axis (instead of primary)

Default

false

Inherited from

ChartOpts.secondaryCatAxis

---

secondaryValAxis?

optional secondaryValAxis?: boolean

Defined in: core-interfaces.ts:2571

Whether data should use secondary value axis (instead of primary)

Default

false

Inherited from

ChartOpts.secondaryValAxis

---

serAxisBaseTimeUnit?

optional serAxisBaseTimeUnit?: string

Defined in: core-interfaces.ts:2541

Inherited from

ChartOpts.serAxisBaseTimeUnit

---

serAxisHidden?

optional serAxisHidden?: boolean

Defined in: core-interfaces.ts:2542

Inherited from

ChartOpts.serAxisHidden

---

serAxisLabelColor?

optional serAxisLabelColor?: string

Defined in: core-interfaces.ts:2543

Inherited from

ChartOpts.serAxisLabelColor

---

serAxisLabelFontBold?

optional serAxisLabelFontBold?: boolean

Defined in: core-interfaces.ts:2544

Inherited from

ChartOpts.serAxisLabelFontBold

---

serAxisLabelFontFace?

optional serAxisLabelFontFace?: string

Defined in: core-interfaces.ts:2545

Inherited from

ChartOpts.serAxisLabelFontFace

---

serAxisLabelFontItalic?

optional serAxisLabelFontItalic?: boolean

Defined in: core-interfaces.ts:2546

Inherited from

ChartOpts.serAxisLabelFontItalic

---

serAxisLabelFontSize?

optional serAxisLabelFontSize?: number

Defined in: core-interfaces.ts:2547

Inherited from

ChartOpts.serAxisLabelFontSize

---

serAxisLabelFrequency?

optional serAxisLabelFrequency?: string

Defined in: core-interfaces.ts:2548

Inherited from

ChartOpts.serAxisLabelFrequency

---

serAxisLabelPos?

optional serAxisLabelPos?: "none" | "high" | "low" | "nextTo"

Defined in: core-interfaces.ts:2549

Inherited from

ChartOpts.serAxisLabelPos

---

serAxisLineColor?

optional serAxisLineColor?: string

Defined in: core-interfaces.ts:2550

Inherited from

ChartOpts.serAxisLineColor

---

serAxisLineShow?

optional serAxisLineShow?: boolean

Defined in: core-interfaces.ts:2551

Inherited from

ChartOpts.serAxisLineShow

---

serAxisMajorTimeUnit?

optional serAxisMajorTimeUnit?: string

Defined in: core-interfaces.ts:2552

Inherited from

ChartOpts.serAxisMajorTimeUnit

---

serAxisMajorUnit?

optional serAxisMajorUnit?: number

Defined in: core-interfaces.ts:2553

Inherited from

ChartOpts.serAxisMajorUnit

---

serAxisMinorTimeUnit?

optional serAxisMinorTimeUnit?: string

Defined in: core-interfaces.ts:2554

Inherited from

ChartOpts.serAxisMinorTimeUnit

---

serAxisMinorUnit?

optional serAxisMinorUnit?: number

Defined in: core-interfaces.ts:2555

Inherited from

ChartOpts.serAxisMinorUnit

---

serAxisOrientation?

optional serAxisOrientation?: string

Defined in: core-interfaces.ts:2556

Inherited from

ChartOpts.serAxisOrientation

---

serAxisTitle?

optional serAxisTitle?: string

Defined in: core-interfaces.ts:2557

Inherited from

ChartOpts.serAxisTitle

---

serAxisTitleColor?

optional serAxisTitleColor?: string

Defined in: core-interfaces.ts:2558

Inherited from

ChartOpts.serAxisTitleColor

---

serAxisTitleFontFace?

optional serAxisTitleFontFace?: string

Defined in: core-interfaces.ts:2559

Inherited from

ChartOpts.serAxisTitleFontFace

---

serAxisTitleFontSize?

optional serAxisTitleFontSize?: number

Defined in: core-interfaces.ts:2560

Inherited from

ChartOpts.serAxisTitleFontSize

---

serAxisTitleRotate?

optional serAxisTitleRotate?: number

Defined in: core-interfaces.ts:2561

Inherited from

ChartOpts.serAxisTitleRotate

---

serGridLine?

optional serGridLine?: OptsChartGridLine

Defined in: core-interfaces.ts:2562

Inherited from

ChartOpts.serGridLine

---

seriesOptions?

optional seriesOptions?: ChartSeriesOpts[]

Defined in: core-interfaces.ts:2487

Per-series style overrides. Element at index N applies to the series at data[N]. Missing indices or unset fields fall back to the chart-level option.

Inherited from

ChartOpts.seriesOptions

---

serLabelFormatCode?

optional serLabelFormatCode?: string

Defined in: core-interfaces.ts:2563

Inherited from

ChartOpts.serLabelFormatCode

---

shadow?

optional shadow?: ShadowProps

Defined in: core-interfaces.ts:2401

Inherited from

ChartOpts.shadow

---

showBubbleSize?

optional showBubbleSize?: boolean

Defined in: core-interfaces.ts:2407

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

Default

false

Inherited from

ChartOpts.showBubbleSize

---

showCatAxisTitle?

optional showCatAxisTitle?: boolean

Defined in: core-interfaces.ts:2538

Inherited from

ChartOpts.showCatAxisTitle

---

showDataTable?

optional showDataTable?: boolean

Defined in: core-interfaces.ts:2819

Whether to show a data table adjacent to the chart

Default

false

Inherited from

ChartOpts.showDataTable

---

showDataTableHorzBorder?

optional showDataTableHorzBorder?: boolean

Defined in: core-interfaces.ts:2820

Inherited from

ChartOpts.showDataTableHorzBorder

---

showDataTableKeys?

optional showDataTableKeys?: boolean

Defined in: core-interfaces.ts:2821

Inherited from

ChartOpts.showDataTableKeys

---

showDataTableOutline?

optional showDataTableOutline?: boolean

Defined in: core-interfaces.ts:2822

Inherited from

ChartOpts.showDataTableOutline

---

showDataTableVertBorder?

optional showDataTableVertBorder?: boolean

Defined in: core-interfaces.ts:2823

Inherited from

ChartOpts.showDataTableVertBorder

---

showLabel?

optional showLabel?: boolean

Defined in: core-interfaces.ts:2411

Default

false

Inherited from

ChartOpts.showLabel

---

showLeaderLines?

optional showLeaderLines?: boolean

Defined in: core-interfaces.ts:2412

Inherited from

ChartOpts.showLeaderLines

---

showLegend?

optional showLegend?: boolean

Defined in: core-interfaces.ts:2428

Default

false

Inherited from

ChartOpts.showLegend

---

showPercent?

optional showPercent?: boolean

Defined in: core-interfaces.ts:2432

Default

false

Inherited from

ChartOpts.showPercent

---

showSerAxisTitle?

optional showSerAxisTitle?: boolean

Defined in: core-interfaces.ts:2564

Inherited from

ChartOpts.showSerAxisTitle

---

showSerName?

optional showSerName?: boolean

Defined in: core-interfaces.ts:2436

Default

false

Inherited from

ChartOpts.showSerName

---

showTitle?

optional showTitle?: boolean

Defined in: core-interfaces.ts:2440

Default

false

Inherited from

ChartOpts.showTitle

---

showValAxisTitle?

optional showValAxisTitle?: boolean

Defined in: core-interfaces.ts:2572

Inherited from

ChartOpts.showValAxisTitle

---

showValue?

optional showValue?: boolean

Defined in: core-interfaces.ts:2444

Default

false

Inherited from

ChartOpts.showValue

---

size?

optional size?: number

Defined in: core-interfaces.ts:2352

Gridline size (points)

Inherited from

ChartOpts.size

---

softBreakBefore?

optional softBreakBefore?: boolean

Defined in: core-interfaces.ts:712

Add a soft line-break (shift+enter) before line text content

Default

false

Inherited from

ChartOpts.softBreakBefore

---

style?

optional style?: "none" | "dash" | "solid" | "dot"

Defined in: core-interfaces.ts:2356

Gridline style

Inherited from

ChartOpts.style

---

tabStops?

optional tabStops?: object[]

Defined in: core-interfaces.ts:718

tab stops

• PowerPoint: Paragraph > Tabs > Tab stop position

alignment?

optional alignment?: "r" | "l" | "ctr" | "dec"

position

position: number

Example

[{ position:1 }, { position:3 }] // Set first tab stop to 1 inch, set second tab stop to 3 inches

Inherited from

ChartOpts.tabStops

---

textDirection?

optional textDirection?: "horz" | "vert" | "vert270" | "wordArtVert"

Defined in: core-interfaces.ts:727

text direction horz = horizontal vert = rotate 90^ vert270 = rotate 270^ wordArtVert = stacked

Default

'horz'

Inherited from

ChartOpts.textDirection

---

textWarp?

optional textWarp?: string

Defined in: core-interfaces.ts:560

Preset text warp / WordArt shape (<a:bodyPr><a:prstTxWarp prst="..">), which bends the text along a preset path (arch, circle, wave, …). The value is an OOXML ST_TextShapeType preset name.

Examples

'textArchUp' // bend text along an upward arch (e.g. a label following a ring/arc)

'textCircle'

Inherited from

ChartOpts.textWarp

---

title?

optional title?: string

Defined in: core-interfaces.ts:2846

Inherited from

ChartOpts.title

---

titleAlign?

optional titleAlign?: string

Defined in: core-interfaces.ts:2847

Inherited from

ChartOpts.titleAlign

---

titleBold?

optional titleBold?: boolean

Defined in: core-interfaces.ts:2848

Inherited from

ChartOpts.titleBold

---

titleColor?

optional titleColor?: string

Defined in: core-interfaces.ts:2849

Inherited from

ChartOpts.titleColor

---

titleFontFace?

optional titleFontFace?: string

Defined in: core-interfaces.ts:2850

Inherited from

ChartOpts.titleFontFace

---

titleFontSize?

optional titleFontSize?: number

Defined in: core-interfaces.ts:2851

Inherited from

ChartOpts.titleFontSize

---

titleItalic?

optional titleItalic?: boolean

Defined in: core-interfaces.ts:2852

Inherited from

ChartOpts.titleItalic

---

titlePos?

optional titlePos?: object

Defined in: core-interfaces.ts:2859

Manual title position (inches), relative to the chart. Each axis is independent: omit x to keep automatic horizontal centering, or omit y to keep automatic vertical placement. Provide at least one.

x?

optional x?: number

y?

optional y?: number

Inherited from

ChartOpts.titlePos

---

titleRotate?

optional titleRotate?: number

Defined in: core-interfaces.ts:2860

Inherited from

ChartOpts.titleRotate

---

titleUnderline?

optional titleUnderline?: boolean

Defined in: core-interfaces.ts:2853

Inherited from

ChartOpts.titleUnderline

---

transparency?

optional transparency?: number

Defined in: core-interfaces.ts:734

Transparency (percent)

• MS-PPT > Format Shape > Text Options > Text Fill & Outline > Text Fill > Transparency
• range: 0-100

Default

0

Inherited from

ChartOpts.transparency

---

type?

optional type?: "area" | "line" | "pie" | "bar" | "bar3D" | "bubble" | "bubble3D" | "doughnut" | "radar" | "scatter"

Defined in: core-interfaces.ts:2884

Chart type — required when using the canonical addChart(data, options) signature.

• Omit only for multi-type (combo) charts, where each ChartMulti entry carries its own type.

Inherited from

ChartOpts.type

---

underline?

optional underline?: object

Defined in: core-interfaces.ts:740

underline properties

• PowerPoint: Font > Color & Underline > Underline Style/Underline Color

color?

optional color?: string

style?

optional style?: "none" | "dash" | "dashHeavy" | "dashLong" | "dashLongHeavy" | "dbl" | "dotDash" | "dotDashHeave" | "dotDotDash" | "dotDotDashHeavy" | "dotted" | "dottedHeavy" | "heavy" | "sng" | "wavy" | "wavyDbl" | "wavyHeavy"

Default

(none)

Inherited from

ChartOpts.underline

---

v3DPerspective?

optional v3DPerspective?: number

Defined in: core-interfaces.ts:2450

3D Perspecitve

• range: 0-120

Default

30

Inherited from

ChartOpts.v3DPerspective

---

v3DRAngAx?

optional v3DRAngAx?: boolean

Defined in: core-interfaces.ts:2458

Right Angle Axes

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

Default

false

Inherited from

ChartOpts.v3DRAngAx

---

v3DRotX?

optional v3DRotX?: number

Defined in: core-interfaces.ts:2465

X Rotation

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

Default

30

Inherited from

ChartOpts.v3DRotX

---

v3DRotY?

optional v3DRotY?: number

Defined in: core-interfaces.ts:2471

Y Rotation

• range: 0-359.9

Default

30

Inherited from

ChartOpts.v3DRotY

---

valAxes?

optional valAxes?: ChartPropsAxisVal[]

Defined in: core-interfaces.ts:2576

Multi-Chart prop: array of val axes

Inherited from

ChartOpts.valAxes

---

valAxisCrossBetween?

optional valAxisCrossBetween?: "between" | "midCat"

Defined in: core-interfaces.ts:2584

Controls where axis values are plotted relative to tick marks

• 'between' = values plotted between tick marks (default for bar/column/line)
• 'midCat' = values plotted on tick marks (default for scatter/area)
• PowerPoint: Format Axis > Axis Options > Axis crosses > On tick marks / Between tick marks

Inherited from

ChartOpts.valAxisCrossBetween

---

valAxisCrossesAt?

optional valAxisCrossesAt?: number | "autoZero"

Defined in: core-interfaces.ts:2577

Inherited from

ChartOpts.valAxisCrossesAt

---

valAxisDisplayUnit?

optional valAxisDisplayUnit?: "billions" | "hundredMillions" | "hundreds" | "hundredThousands" | "millions" | "tenMillions" | "tenThousands" | "thousands" | "trillions"

Defined in: core-interfaces.ts:2585

Inherited from

ChartOpts.valAxisDisplayUnit

---

valAxisDisplayUnitLabel?

optional valAxisDisplayUnitLabel?: boolean

Defined in: core-interfaces.ts:2595

Inherited from

ChartOpts.valAxisDisplayUnitLabel

---

valAxisHidden?

optional valAxisHidden?: boolean

Defined in: core-interfaces.ts:2596

Inherited from

ChartOpts.valAxisHidden

---

valAxisLabelColor?

optional valAxisLabelColor?: string

Defined in: core-interfaces.ts:2597

Inherited from

ChartOpts.valAxisLabelColor

---

valAxisLabelFontBold?

optional valAxisLabelFontBold?: boolean

Defined in: core-interfaces.ts:2598

Inherited from

ChartOpts.valAxisLabelFontBold

---

valAxisLabelFontFace?

optional valAxisLabelFontFace?: string

Defined in: core-interfaces.ts:2599

Inherited from

ChartOpts.valAxisLabelFontFace

---

valAxisLabelFontItalic?

optional valAxisLabelFontItalic?: boolean

Defined in: core-interfaces.ts:2600

Inherited from

ChartOpts.valAxisLabelFontItalic

---

valAxisLabelFontSize?

optional valAxisLabelFontSize?: number

Defined in: core-interfaces.ts:2601

Inherited from

ChartOpts.valAxisLabelFontSize

---

valAxisLabelFormatCode?

optional valAxisLabelFormatCode?: string

Defined in: core-interfaces.ts:2602

Inherited from

ChartOpts.valAxisLabelFormatCode

---

valAxisLabelPos?

optional valAxisLabelPos?: "none" | "high" | "low" | "nextTo"

Defined in: core-interfaces.ts:2603

Inherited from

ChartOpts.valAxisLabelPos

---

valAxisLabelRotate?

optional valAxisLabelRotate?: number

Defined in: core-interfaces.ts:2604

Inherited from

ChartOpts.valAxisLabelRotate

---

valAxisLineColor?

optional valAxisLineColor?: string

Defined in: core-interfaces.ts:2605

Inherited from

ChartOpts.valAxisLineColor

---

valAxisLineShow?

optional valAxisLineShow?: boolean

Defined in: core-interfaces.ts:2606

Inherited from

ChartOpts.valAxisLineShow

---

valAxisLineSize?

optional valAxisLineSize?: number

Defined in: core-interfaces.ts:2607

Inherited from

ChartOpts.valAxisLineSize

---

valAxisLineStyle?

optional valAxisLineStyle?: "dash" | "solid" | "dot"

Defined in: core-interfaces.ts:2608

Inherited from

ChartOpts.valAxisLineStyle

---

valAxisLogScaleBase?

optional valAxisLogScaleBase?: number

Defined in: core-interfaces.ts:2613

PowerPoint: Format Axis > Axis Options > Logarithmic scale - Base

• range: 2-99

Inherited from

ChartOpts.valAxisLogScaleBase

---

valAxisMajorTickMark?

optional valAxisMajorTickMark?: ChartAxisTickMark

Defined in: core-interfaces.ts:2614

Inherited from

ChartOpts.valAxisMajorTickMark

---

valAxisMajorUnit?

optional valAxisMajorUnit?: number

Defined in: core-interfaces.ts:2615

Inherited from

ChartOpts.valAxisMajorUnit

---

valAxisMaxVal?

optional valAxisMaxVal?: number

Defined in: core-interfaces.ts:2616

Inherited from

ChartOpts.valAxisMaxVal

---

valAxisMinorTickMark?

optional valAxisMinorTickMark?: ChartAxisTickMark

Defined in: core-interfaces.ts:2617

Inherited from

ChartOpts.valAxisMinorTickMark

---

valAxisMinVal?

optional valAxisMinVal?: number

Defined in: core-interfaces.ts:2618

Inherited from

ChartOpts.valAxisMinVal

---

valAxisOrientation?

optional valAxisOrientation?: "minMax" | "maxMin"

Defined in: core-interfaces.ts:2619

Inherited from

ChartOpts.valAxisOrientation

---

valAxisTitle?

optional valAxisTitle?: string

Defined in: core-interfaces.ts:2620

Inherited from

ChartOpts.valAxisTitle

---

valAxisTitleColor?

optional valAxisTitleColor?: string

Defined in: core-interfaces.ts:2621

Inherited from

ChartOpts.valAxisTitleColor

---

valAxisTitleFontFace?

optional valAxisTitleFontFace?: string

Defined in: core-interfaces.ts:2622

Inherited from

ChartOpts.valAxisTitleFontFace

---

valAxisTitleFontSize?

optional valAxisTitleFontSize?: number

Defined in: core-interfaces.ts:2623

Inherited from

ChartOpts.valAxisTitleFontSize

---

valAxisTitleRotate?

optional valAxisTitleRotate?: number

Defined in: core-interfaces.ts:2624

Inherited from

ChartOpts.valAxisTitleRotate

---

valGridLine?

optional valGridLine?: OptsChartGridLine

Defined in: core-interfaces.ts:2625

Inherited from

ChartOpts.valGridLine

---

valign?

optional valign?: VAlign

Defined in: core-interfaces.ts:765

vertical alignment

Default

'top'

Inherited from

ChartOpts.valign

---

valLabelFormatCode?

optional valLabelFormatCode?: string

Defined in: core-interfaces.ts:2633

Value label format code

• this also directs Data Table formatting

Examples

'#%' // round percent

'0.00%' // shows values as '0.00%'

'$0.00' // shows values as '$0.00'

Inherited from

ChartOpts.valLabelFormatCode

---

w?

optional w?: Coord

Defined in: core-interfaces.ts:68

Width

• inches or percentage

Examples

10.25 // width in inches

'75%' // width as percentage of slide size

Inherited from

ChartOpts.w

---

x?

optional x?: Coord

Defined in: core-interfaces.ts:47

Horizontal position

• inches or percentage

Examples

10.25 // position in inches

'75%' // position as percentage of slide size

Inherited from

ChartOpts.x

---

y?

optional y?: Coord

Defined in: core-interfaces.ts:54

Vertical position

• inches or percentage

Examples

10.25 // position in inches

'75%' // position as percentage of slide size

Inherited from

ChartOpts.y