Skip to content

@shbernal/pptxgenjs


@shbernal/pptxgenjs / index / IChartOpts

Interface: IChartOpts

Defined in: core-interfaces.ts:2672

Extends

Extended by

Properties

align?

optional align?: HAlign

Defined in: core-interfaces.ts:521

Horizontal alignment

Default

ts
'left'

Inherited from

IChartPropsTitle.align


altText?

optional altText?: string

Defined in: core-interfaces.ts:2693

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..."

Overrides

ObjectNameProps.altText


axisPos?

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

Defined in: core-interfaces.ts:2198

Axis position

Inherited from

IChartPropsBase.axisPos


bar3DShape?

optional bar3DShape?: string

Defined in: core-interfaces.ts:2450

Inherited from

IChartPropsChartBar.bar3DShape


barDir?

optional barDir?: string

Defined in: core-interfaces.ts:2451

Inherited from

IChartPropsChartBar.barDir


barGapDepthPct?

optional barGapDepthPct?: number

Defined in: core-interfaces.ts:2452

Inherited from

IChartPropsChartBar.barGapDepthPct


barGapWidthPct?

optional barGapWidthPct?: number

Defined in: core-interfaces.ts:2459

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

  • width (percent)
  • range: 0-500

Default

ts
150

Inherited from

IChartPropsChartBar.barGapWidthPct


barGrouping?

optional barGrouping?: string

Defined in: core-interfaces.ts:2460

Inherited from

IChartPropsChartBar.barGrouping


barOverlapPct?

optional barOverlapPct?: number

Defined in: core-interfaces.ts:2468

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

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

Since

v3.9.0

Default

ts
0

Inherited from

IChartPropsChartBar.barOverlapPct


barSeriesLine?

optional barSeriesLine?: boolean | OptsChartGridLine

Defined in: core-interfaces.ts:2482

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

ts
undefined

Examples

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

Inherited from

IChartPropsChartBar.barSeriesLine


bold?

optional bold?: boolean

Defined in: core-interfaces.ts:526

Bold style

Default

ts
false

Inherited from

IChartPropsTitle.bold


border?

optional border?: BorderProps

Defined in: core-interfaces.ts:2296

Deprecated

v3.11.0 - use plotArea.border

Inherited from

IChartPropsBase.border


breakLine?

optional breakLine?: boolean

Defined in: core-interfaces.ts:531

Add a line-break

Default

ts
false

Inherited from

IChartPropsTitle.breakLine


bullet?

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

Defined in: core-interfaces.ts:547

Add standard or custom bullet

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

Union Members

boolean


Type Literal

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

characterCode?

optional characterCode?: string

Bullet character code (unicode)

Since

v3.3.0

Example
ts
'25BA' // 'BLACK RIGHT-POINTING POINTER' (U+25BA)
code?

optional code?: string

Bullet code (unicode)

Deprecated

v3.3.0 - use characterCode

color?

optional color?: string

Bullet glyph color (separate from the text run color)

Since

v4.0.0

Example
ts
'FF0000' // red bullet
fontFace?

optional fontFace?: string

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

Since

v4.0.0

Example
ts
'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) are recommended; use size to scale relative to the text height
  • takes precedence over type/characterCode when set
Since

v4.0.0

Examples
ts
image: { path: 'images/star.png' }
ts
image: { data: 'image/png;base64,iVBOR...' }
image.data?

optional data?: string

image.path?

optional path?: string

indent?

optional indent?: number

Indentation (space between bullet and text) (points)

Since

v3.3.0

Default
ts
27 // DEF_BULLET_MARGIN
Example
ts
10 // Indents text 10 points from bullet
marginPt?

optional marginPt?: number

Margin between bullet and text

Since

v3.2.1

Deprecated

v3.3.0 - use indent

numberStartAt?

optional numberStartAt?: number

Number bullets start at

Since

v3.3.0

Default
ts
1
Example
ts
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

Since

v3.3.0

Example
ts
'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)

Since

v4.0.0

Default
ts
100
Example
ts
80 // bullet glyph is 80% of the text size
startAt?

optional startAt?: number

Number to start with (only applies to type:number)

Deprecated

v3.3.0 - use numberStartAt

style?

optional style?: string

Number type

Deprecated

v3.3.0 - use numberType

type?

optional type?: "number" | "bullet"

Bullet type

Default
ts
bullet

Default

ts
false

Inherited from

IChartPropsTitle.bullet


cap?

optional cap?: LineCap

Defined in: core-interfaces.ts:2150

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

  • line cap type

Default

ts
flat

Inherited from

OptsChartGridLine.cap


caps?

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

Defined in: core-interfaces.ts:663

Text capitalization

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

Inherited from

IChartPropsTitle.caps


catAxes?

optional catAxes?: IChartPropsAxisCat[]

Defined in: core-interfaces.ts:2313

Multi-Chart prop: array of cat axes

Inherited from

IChartPropsAxisCat.catAxes


catAxisBaseTimeUnit?

optional catAxisBaseTimeUnit?: string

Defined in: core-interfaces.ts:2314

Inherited from

IChartPropsAxisCat.catAxisBaseTimeUnit


catAxisCrossesAt?

optional catAxisCrossesAt?: number | "autoZero"

Defined in: core-interfaces.ts:2315

Inherited from

IChartPropsAxisCat.catAxisCrossesAt


catAxisHidden?

optional catAxisHidden?: boolean

Defined in: core-interfaces.ts:2316

Inherited from

IChartPropsAxisCat.catAxisHidden


catAxisLabelColor?

optional catAxisLabelColor?: string

Defined in: core-interfaces.ts:2317

Inherited from

IChartPropsAxisCat.catAxisLabelColor


catAxisLabelFontBold?

optional catAxisLabelFontBold?: boolean

Defined in: core-interfaces.ts:2318

Inherited from

IChartPropsAxisCat.catAxisLabelFontBold


catAxisLabelFontFace?

optional catAxisLabelFontFace?: string

Defined in: core-interfaces.ts:2319

Inherited from

IChartPropsAxisCat.catAxisLabelFontFace


catAxisLabelFontItalic?

optional catAxisLabelFontItalic?: boolean

Defined in: core-interfaces.ts:2320

Inherited from

IChartPropsAxisCat.catAxisLabelFontItalic


catAxisLabelFontSize?

optional catAxisLabelFontSize?: number

Defined in: core-interfaces.ts:2321

Inherited from

IChartPropsAxisCat.catAxisLabelFontSize


catAxisLabelFormatCode?

optional catAxisLabelFormatCode?: string

Defined in: core-interfaces.ts:2328

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

IChartPropsAxisCat.catAxisLabelFormatCode


catAxisLabelFrequency?

optional catAxisLabelFrequency?: string

Defined in: core-interfaces.ts:2329

Inherited from

IChartPropsAxisCat.catAxisLabelFrequency


catAxisLabelPos?

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

Defined in: core-interfaces.ts:2330

Inherited from

IChartPropsAxisCat.catAxisLabelPos


catAxisLabelRotate?

optional catAxisLabelRotate?: number

Defined in: core-interfaces.ts:2331

Inherited from

IChartPropsAxisCat.catAxisLabelRotate


catAxisLineColor?

optional catAxisLineColor?: string

Defined in: core-interfaces.ts:2332

Inherited from

IChartPropsAxisCat.catAxisLineColor


catAxisLineShow?

optional catAxisLineShow?: boolean

Defined in: core-interfaces.ts:2333

Inherited from

IChartPropsAxisCat.catAxisLineShow


catAxisLineSize?

optional catAxisLineSize?: number

Defined in: core-interfaces.ts:2334

Inherited from

IChartPropsAxisCat.catAxisLineSize


catAxisLineStyle?

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

Defined in: core-interfaces.ts:2335

Inherited from

IChartPropsAxisCat.catAxisLineStyle


catAxisMajorTickMark?

optional catAxisMajorTickMark?: ChartAxisTickMark

Defined in: core-interfaces.ts:2336

Inherited from

IChartPropsAxisCat.catAxisMajorTickMark


catAxisMajorTimeUnit?

optional catAxisMajorTimeUnit?: string

Defined in: core-interfaces.ts:2337

Inherited from

IChartPropsAxisCat.catAxisMajorTimeUnit


catAxisMajorUnit?

optional catAxisMajorUnit?: number

Defined in: core-interfaces.ts:2338

Inherited from

IChartPropsAxisCat.catAxisMajorUnit


catAxisMaxVal?

optional catAxisMaxVal?: number

Defined in: core-interfaces.ts:2339

Inherited from

IChartPropsAxisCat.catAxisMaxVal


catAxisMinorTickMark?

optional catAxisMinorTickMark?: ChartAxisTickMark

Defined in: core-interfaces.ts:2340

Inherited from

IChartPropsAxisCat.catAxisMinorTickMark


catAxisMinorTimeUnit?

optional catAxisMinorTimeUnit?: string

Defined in: core-interfaces.ts:2341

Inherited from

IChartPropsAxisCat.catAxisMinorTimeUnit


catAxisMinorUnit?

optional catAxisMinorUnit?: number

Defined in: core-interfaces.ts:2342

Inherited from

IChartPropsAxisCat.catAxisMinorUnit


catAxisMinVal?

optional catAxisMinVal?: number

Defined in: core-interfaces.ts:2343

Inherited from

IChartPropsAxisCat.catAxisMinVal


catAxisMultiLevelLabels?

optional catAxisMultiLevelLabels?: boolean

Defined in: core-interfaces.ts:2345

Since

v3.11.0

Inherited from

IChartPropsAxisCat.catAxisMultiLevelLabels


catAxisOrientation?

optional catAxisOrientation?: "minMax" | "maxMin"

Defined in: core-interfaces.ts:2346

Inherited from

IChartPropsAxisCat.catAxisOrientation


catAxisTitle?

optional catAxisTitle?: string

Defined in: core-interfaces.ts:2347

Inherited from

IChartPropsAxisCat.catAxisTitle


catAxisTitleColor?

optional catAxisTitleColor?: string

Defined in: core-interfaces.ts:2348

Inherited from

IChartPropsAxisCat.catAxisTitleColor


catAxisTitleFontFace?

optional catAxisTitleFontFace?: string

Defined in: core-interfaces.ts:2349

Inherited from

IChartPropsAxisCat.catAxisTitleFontFace


catAxisTitleFontSize?

optional catAxisTitleFontSize?: number

Defined in: core-interfaces.ts:2350

Inherited from

IChartPropsAxisCat.catAxisTitleFontSize


catAxisTitleRotate?

optional catAxisTitleRotate?: number

Defined in: core-interfaces.ts:2351

Inherited from

IChartPropsAxisCat.catAxisTitleRotate


catGridLine?

optional catGridLine?: OptsChartGridLine

Defined in: core-interfaces.ts:2352

Inherited from

IChartPropsAxisCat.catGridLine


catLabelFormatCode?

optional catLabelFormatCode?: string

Defined in: core-interfaces.ts:2353

Inherited from

IChartPropsAxisCat.catLabelFormatCode


chartArea?

optional chartArea?: IChartAreaProps

Defined in: core-interfaces.ts:2286

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

Since

v3.11

Inherited from

IChartPropsBase.chartArea


chartColors?

optional chartColors?: string[]

Defined in: core-interfaces.ts:2199

Inherited from

IChartPropsBase.chartColors


chartColorsOpacity?

optional chartColorsOpacity?: number

Defined in: core-interfaces.ts:2204

opacity (0 - 100)

Example

ts
50 // 50% opaque

Inherited from

IChartPropsBase.chartColorsOpacity


color?

optional color?: string

Defined in: core-interfaces.ts:671

Text color

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

Examples

ts
'FF0000' // hex color (red)
ts
pptx.SchemeColor.text1 // Theme color (Text1)

Inherited from

IChartPropsTitle.color


dataBorder?

optional dataBorder?: BorderProps

Defined in: core-interfaces.ts:2205

Inherited from

IChartPropsBase.dataBorder


dataLabelBkgrdColors?

optional dataLabelBkgrdColors?: boolean

Defined in: core-interfaces.ts:2599

Inherited from

IChartPropsDataLabel.dataLabelBkgrdColors


dataLabelColor?

optional dataLabelColor?: string

Defined in: core-interfaces.ts:2600

Inherited from

IChartPropsDataLabel.dataLabelColor


dataLabelFontBold?

optional dataLabelFontBold?: boolean

Defined in: core-interfaces.ts:2601

Inherited from

IChartPropsDataLabel.dataLabelFontBold


dataLabelFontFace?

optional dataLabelFontFace?: string

Defined in: core-interfaces.ts:2602

Inherited from

IChartPropsDataLabel.dataLabelFontFace


dataLabelFontItalic?

optional dataLabelFontItalic?: boolean

Defined in: core-interfaces.ts:2603

Inherited from

IChartPropsDataLabel.dataLabelFontItalic


dataLabelFontSize?

optional dataLabelFontSize?: number

Defined in: core-interfaces.ts:2604

Inherited from

IChartPropsDataLabel.dataLabelFontSize


dataLabelFormatCode?

optional dataLabelFormatCode?: string

Defined in: core-interfaces.ts:2611

Data label format code

Examples

ts
'#%' // round percent
ts
'0.00%' // shows values as '0.00%'
ts
'$0.00' // shows values as '$0.00'

Inherited from

IChartPropsDataLabel.dataLabelFormatCode


dataLabelFormatScatter?

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

Defined in: core-interfaces.ts:2612

Inherited from

IChartPropsDataLabel.dataLabelFormatScatter


dataLabelPosition?

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

Defined in: core-interfaces.ts:2613

Inherited from

IChartPropsDataLabel.dataLabelPosition


dataNoEffects?

optional dataNoEffects?: boolean

Defined in: core-interfaces.ts:2485

Inherited from

IChartPropsChartDoughnut.dataNoEffects


dataTableFontSize?

optional dataTableFontSize?: number

Defined in: core-interfaces.ts:2616

Inherited from

IChartPropsDataTable.dataTableFontSize


dataTableFormatCode?

optional dataTableFormatCode?: string

Defined in: core-interfaces.ts:2624

Data table format code

Since

v3.3.0

Examples

ts
'#%' // round percent
ts
'0.00%' // shows values as '0.00%'
ts
'$0.00' // shows values as '$0.00'

Inherited from

IChartPropsDataTable.dataTableFormatCode


displayBlanksAs?

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

Defined in: core-interfaces.ts:2206

Inherited from

IChartPropsBase.displayBlanksAs


fill?

optional fill?: string

Defined in: core-interfaces.ts:2300

Deprecated

v3.11.0 - use plotArea.fill

Inherited from

IChartPropsBase.fill


firstSliceAng?

optional firstSliceAng?: number

Defined in: core-interfaces.ts:2555

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

  • angle (degrees)
  • range: 0-359

Since

v3.4.0

Default

ts
0

Inherited from

IChartPropsChartPie.firstSliceAng


fontFace?

optional fontFace?: string

Defined in: core-interfaces.ts:681

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

ts
'Arial' // Arial font

Inherited from

IChartPropsTitle.fontFace


fontFaceEA?

optional fontFaceEA?: string

Defined in: core-interfaces.ts:689

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

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

Inherited from

IChartPropsTitle.fontFaceEA


fontSize?

optional fontSize?: number

Defined in: core-interfaces.ts:694

Font size

Example

ts
12 // Font size 12

Inherited from

IChartPropsTitle.fontSize


h?

optional h?: Coord

Defined in: core-interfaces.ts:47

Height

  • inches or percentage

Examples

ts
10.25 // height in inches
ts
'75%' // height as percentage of slide size

Inherited from

PositionProps.h


highlight?

optional highlight?: string

Defined in: core-interfaces.ts:699

Text highlight color (hex format)

Example

ts
'FFFF00' // yellow

Inherited from

IChartPropsTitle.highlight


holeSize?

optional holeSize?: number

Defined in: core-interfaces.ts:2486

Inherited from

IChartPropsChartDoughnut.holeSize


invertedColors?

optional invertedColors?: string[]

Defined in: core-interfaces.ts:2207

Inherited from

IChartPropsBase.invertedColors


italic?

optional italic?: boolean

Defined in: core-interfaces.ts:704

italic style

Default

ts
false

Inherited from

IChartPropsTitle.italic


lang?

optional lang?: string

Defined in: core-interfaces.ts:2208

language

  • ISO 639-1 standard language code

Default

ts
'en-US' // english US

Example

ts
'fr-CA' // french Canadian

Inherited from

IChartPropsBase.lang


layout?

optional layout?: PositionProps

Defined in: core-interfaces.ts:2209

Inherited from

IChartPropsBase.layout


leaderLineColor?

optional leaderLineColor?: string

Defined in: core-interfaces.ts:2227

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

Inherited from

IChartPropsBase.leaderLineColor


leaderLineSize?

optional leaderLineSize?: number

Defined in: core-interfaces.ts:2233

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

Default

ts
0.75

Example

ts
1.5

Inherited from

IChartPropsBase.leaderLineSize


legendColor?

optional legendColor?: string

Defined in: core-interfaces.ts:2636

Inherited from

IChartPropsLegend.legendColor


legendFontFace?

optional legendFontFace?: string

Defined in: core-interfaces.ts:2637

Inherited from

IChartPropsLegend.legendFontFace


legendFontSize?

optional legendFontSize?: number

Defined in: core-interfaces.ts:2638

Inherited from

IChartPropsLegend.legendFontSize


legendLayout?

optional legendLayout?: PositionProps

Defined in: core-interfaces.ts:2652

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

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

Inherited from

IChartPropsLegend.legendLayout


legendPos?

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

Defined in: core-interfaces.ts:2653

Inherited from

IChartPropsLegend.legendPos


lineCap?

optional lineCap?: LineCap

Defined in: core-interfaces.ts:2494

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

  • line cap type

Default

ts
flat

Inherited from

IChartPropsChartLine.lineCap


lineDash?

optional lineDash?: ChartLineDash

Defined in: core-interfaces.ts:2500

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

  • applies to every series that has no entry in lineDashValues

Default

ts
solid

Inherited from

IChartPropsChartLine.lineDash


lineDashValues?

optional lineDashValues?: ChartLineDash[]

Defined in: core-interfaces.ts:2506

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

IChartPropsChartLine.lineDashValues


lineDataSymbol?

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

Defined in: core-interfaces.ts:2512

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

  • marker type

Default

ts
circle

Inherited from

IChartPropsChartLine.lineDataSymbol


lineDataSymbolLineColor?

optional lineDataSymbolLineColor?: string

Defined in: core-interfaces.ts:2518

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

  • border color

Default

ts
circle

Inherited from

IChartPropsChartLine.lineDataSymbolLineColor


lineDataSymbolLineSize?

optional lineDataSymbolLineSize?: number

Defined in: core-interfaces.ts:2524

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

  • border width (points)

Default

ts
0.75

Inherited from

IChartPropsChartLine.lineDataSymbolLineSize


lineDataSymbolSize?

optional lineDataSymbolSize?: number

Defined in: core-interfaces.ts:2531

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

  • marker size
  • range: 2-72

Default

ts
6

Inherited from

IChartPropsChartLine.lineDataSymbolSize


lineSize?

optional lineSize?: number

Defined in: core-interfaces.ts:2538

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

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

Default

ts
2

Inherited from

IChartPropsChartLine.lineSize


lineSmooth?

optional lineSmooth?: boolean

Defined in: core-interfaces.ts:2544

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

  • "Smoothed line"

Default

ts
false

Inherited from

IChartPropsChartLine.lineSmooth


objectLock?

optional objectLock?: ObjectLockProps

Defined in: core-interfaces.ts:819

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

Since

v4.0.0

Examples

ts
{ noMove: true, noResize: true } // pin an object in place
ts
{ noGrp: true } // exclude from grouping

Inherited from

ObjectNameProps.objectLock


objectName?

optional objectName?: string

Defined in: core-interfaces.ts:799

Object name

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

Since

v3.10.0

Default

ts
'Object 1'

Example

ts
'Antenna Design 9'

Inherited from

ObjectNameProps.objectName


plotArea?

optional plotArea?: IChartPropsFillLine

Defined in: core-interfaces.ts:2291

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

Since

v3.11

Inherited from

IChartPropsBase.plotArea


radarStyle?

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

Defined in: core-interfaces.ts:2563

MS-PPT > Chart Type > Waterfall

  • radar chart type

Default

ts
standard

Inherited from

IChartPropsChartRadar.radarStyle


secondaryCatAxis?

optional secondaryCatAxis?: boolean

Defined in: core-interfaces.ts:2358

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

Default

ts
false

Inherited from

IChartPropsAxisCat.secondaryCatAxis


secondaryValAxis?

optional secondaryValAxis?: boolean

Defined in: core-interfaces.ts:2392

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

Default

ts
false

Inherited from

IChartPropsAxisVal.secondaryValAxis


serAxisBaseTimeUnit?

optional serAxisBaseTimeUnit?: string

Defined in: core-interfaces.ts:2362

Inherited from

IChartPropsAxisSer.serAxisBaseTimeUnit


serAxisHidden?

optional serAxisHidden?: boolean

Defined in: core-interfaces.ts:2363

Inherited from

IChartPropsAxisSer.serAxisHidden


serAxisLabelColor?

optional serAxisLabelColor?: string

Defined in: core-interfaces.ts:2364

Inherited from

IChartPropsAxisSer.serAxisLabelColor


serAxisLabelFontBold?

optional serAxisLabelFontBold?: boolean

Defined in: core-interfaces.ts:2365

Inherited from

IChartPropsAxisSer.serAxisLabelFontBold


serAxisLabelFontFace?

optional serAxisLabelFontFace?: string

Defined in: core-interfaces.ts:2366

Inherited from

IChartPropsAxisSer.serAxisLabelFontFace


serAxisLabelFontItalic?

optional serAxisLabelFontItalic?: boolean

Defined in: core-interfaces.ts:2367

Inherited from

IChartPropsAxisSer.serAxisLabelFontItalic


serAxisLabelFontSize?

optional serAxisLabelFontSize?: number

Defined in: core-interfaces.ts:2368

Inherited from

IChartPropsAxisSer.serAxisLabelFontSize


serAxisLabelFrequency?

optional serAxisLabelFrequency?: string

Defined in: core-interfaces.ts:2369

Inherited from

IChartPropsAxisSer.serAxisLabelFrequency


serAxisLabelPos?

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

Defined in: core-interfaces.ts:2370

Inherited from

IChartPropsAxisSer.serAxisLabelPos


serAxisLineColor?

optional serAxisLineColor?: string

Defined in: core-interfaces.ts:2371

Inherited from

IChartPropsAxisSer.serAxisLineColor


serAxisLineShow?

optional serAxisLineShow?: boolean

Defined in: core-interfaces.ts:2372

Inherited from

IChartPropsAxisSer.serAxisLineShow


serAxisMajorTimeUnit?

optional serAxisMajorTimeUnit?: string

Defined in: core-interfaces.ts:2373

Inherited from

IChartPropsAxisSer.serAxisMajorTimeUnit


serAxisMajorUnit?

optional serAxisMajorUnit?: number

Defined in: core-interfaces.ts:2374

Inherited from

IChartPropsAxisSer.serAxisMajorUnit


serAxisMinorTimeUnit?

optional serAxisMinorTimeUnit?: string

Defined in: core-interfaces.ts:2375

Inherited from

IChartPropsAxisSer.serAxisMinorTimeUnit


serAxisMinorUnit?

optional serAxisMinorUnit?: number

Defined in: core-interfaces.ts:2376

Inherited from

IChartPropsAxisSer.serAxisMinorUnit


serAxisOrientation?

optional serAxisOrientation?: string

Defined in: core-interfaces.ts:2377

Inherited from

IChartPropsAxisSer.serAxisOrientation


serAxisTitle?

optional serAxisTitle?: string

Defined in: core-interfaces.ts:2378

Inherited from

IChartPropsAxisSer.serAxisTitle


serAxisTitleColor?

optional serAxisTitleColor?: string

Defined in: core-interfaces.ts:2379

Inherited from

IChartPropsAxisSer.serAxisTitleColor


serAxisTitleFontFace?

optional serAxisTitleFontFace?: string

Defined in: core-interfaces.ts:2380

Inherited from

IChartPropsAxisSer.serAxisTitleFontFace


serAxisTitleFontSize?

optional serAxisTitleFontSize?: number

Defined in: core-interfaces.ts:2381

Inherited from

IChartPropsAxisSer.serAxisTitleFontSize


serAxisTitleRotate?

optional serAxisTitleRotate?: number

Defined in: core-interfaces.ts:2382

Inherited from

IChartPropsAxisSer.serAxisTitleRotate


serGridLine?

optional serGridLine?: OptsChartGridLine

Defined in: core-interfaces.ts:2383

Inherited from

IChartPropsAxisSer.serGridLine


seriesOptions?

optional seriesOptions?: IChartSeriesOpts[]

Defined in: core-interfaces.ts:2307

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.

Since

v4.0.0

Inherited from

IChartPropsBase.seriesOptions


serLabelFormatCode?

optional serLabelFormatCode?: string

Defined in: core-interfaces.ts:2384

Inherited from

IChartPropsAxisSer.serLabelFormatCode


shadow?

optional shadow?: ShadowProps

Defined in: core-interfaces.ts:2210

Inherited from

IChartPropsBase.shadow


showBubbleSize?

optional showBubbleSize?: boolean

Defined in: core-interfaces.ts:2216

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

Default

ts
false

Inherited from

IChartPropsBase.showBubbleSize


showCatAxisTitle?

optional showCatAxisTitle?: boolean

Defined in: core-interfaces.ts:2359

Inherited from

IChartPropsAxisCat.showCatAxisTitle


showDataTable?

optional showDataTable?: boolean

Defined in: core-interfaces.ts:2629

Whether to show a data table adjacent to the chart

Default

ts
false

Inherited from

IChartPropsDataTable.showDataTable


showDataTableHorzBorder?

optional showDataTableHorzBorder?: boolean

Defined in: core-interfaces.ts:2630

Inherited from

IChartPropsDataTable.showDataTableHorzBorder


showDataTableKeys?

optional showDataTableKeys?: boolean

Defined in: core-interfaces.ts:2631

Inherited from

IChartPropsDataTable.showDataTableKeys


showDataTableOutline?

optional showDataTableOutline?: boolean

Defined in: core-interfaces.ts:2632

Inherited from

IChartPropsDataTable.showDataTableOutline


showDataTableVertBorder?

optional showDataTableVertBorder?: boolean

Defined in: core-interfaces.ts:2633

Inherited from

IChartPropsDataTable.showDataTableVertBorder


showLabel?

optional showLabel?: boolean

Defined in: core-interfaces.ts:2220

Default

ts
false

Inherited from

IChartPropsBase.showLabel


showLeaderLines?

optional showLeaderLines?: boolean

Defined in: core-interfaces.ts:2221

Inherited from

IChartPropsBase.showLeaderLines


showLegend?

optional showLegend?: boolean

Defined in: core-interfaces.ts:2237

Default

ts
false

Inherited from

IChartPropsBase.showLegend


showPercent?

optional showPercent?: boolean

Defined in: core-interfaces.ts:2241

Default

ts
false

Inherited from

IChartPropsBase.showPercent


showSerAxisTitle?

optional showSerAxisTitle?: boolean

Defined in: core-interfaces.ts:2385

Inherited from

IChartPropsAxisSer.showSerAxisTitle


showSerName?

optional showSerName?: boolean

Defined in: core-interfaces.ts:2245

Default

ts
false

Inherited from

IChartPropsBase.showSerName


showTitle?

optional showTitle?: boolean

Defined in: core-interfaces.ts:2249

Default

ts
false

Inherited from

IChartPropsBase.showTitle


showValAxisTitle?

optional showValAxisTitle?: boolean

Defined in: core-interfaces.ts:2393

Inherited from

IChartPropsAxisVal.showValAxisTitle


showValue?

optional showValue?: boolean

Defined in: core-interfaces.ts:2253

Default

ts
false

Inherited from

IChartPropsBase.showValue


size?

optional size?: number

Defined in: core-interfaces.ts:2159

Gridline size (points)

Inherited from

OptsChartGridLine.size


softBreakBefore?

optional softBreakBefore?: boolean

Defined in: core-interfaces.ts:717

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

Default

ts
false

Since

v3.5.0

Inherited from

IChartPropsTitle.softBreakBefore


style?

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

Defined in: core-interfaces.ts:2163

Gridline style

Inherited from

OptsChartGridLine.style


tabStops?

optional tabStops?: object[]

Defined in: core-interfaces.ts:723

tab stops

  • PowerPoint: Paragraph > Tabs > Tab stop position

alignment?

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

position

position: number

Example

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

Inherited from

IChartPropsTitle.tabStops


textDirection?

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

Defined in: core-interfaces.ts:732

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

Default

ts
'horz'

Inherited from

IChartPropsTitle.textDirection


textWarp?

optional textWarp?: string

Defined in: core-interfaces.ts:540

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.

Since

v4.0.0

Examples

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

Inherited from

IChartPropsTitle.textWarp


title?

optional title?: string

Defined in: core-interfaces.ts:2656

Inherited from

IChartPropsTitle.title


titleAlign?

optional titleAlign?: string

Defined in: core-interfaces.ts:2657

Inherited from

IChartPropsTitle.titleAlign


titleBold?

optional titleBold?: boolean

Defined in: core-interfaces.ts:2658

Inherited from

IChartPropsTitle.titleBold


titleColor?

optional titleColor?: string

Defined in: core-interfaces.ts:2659

Inherited from

IChartPropsTitle.titleColor


titleFontFace?

optional titleFontFace?: string

Defined in: core-interfaces.ts:2660

Inherited from

IChartPropsTitle.titleFontFace


titleFontSize?

optional titleFontSize?: number

Defined in: core-interfaces.ts:2661

Inherited from

IChartPropsTitle.titleFontSize


titleItalic?

optional titleItalic?: boolean

Defined in: core-interfaces.ts:2662

Inherited from

IChartPropsTitle.titleItalic


titlePos?

optional titlePos?: object

Defined in: core-interfaces.ts:2669

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

IChartPropsTitle.titlePos


titleRotate?

optional titleRotate?: number

Defined in: core-interfaces.ts:2670

Inherited from

IChartPropsTitle.titleRotate


titleUnderline?

optional titleUnderline?: boolean

Defined in: core-interfaces.ts:2663

Inherited from

IChartPropsTitle.titleUnderline


transparency?

optional transparency?: number

Defined in: core-interfaces.ts:739

Transparency (percent)

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

Default

ts
0

Inherited from

IChartPropsTitle.transparency


underline?

optional underline?: object

Defined in: core-interfaces.ts:745

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

ts
(none)

Inherited from

IChartPropsTitle.underline


v3DPerspective?

optional v3DPerspective?: number

Defined in: core-interfaces.ts:2259

3D Perspecitve

  • range: 0-120

Default

ts
30

Inherited from

IChartPropsBase.v3DPerspective


v3DRAngAx?

optional v3DRAngAx?: boolean

Defined in: core-interfaces.ts:2267

Right Angle Axes

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

Default

ts
false

Inherited from

IChartPropsBase.v3DRAngAx


v3DRotX?

optional v3DRotX?: number

Defined in: core-interfaces.ts:2274

X Rotation

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

Default

ts
30

Inherited from

IChartPropsBase.v3DRotX


v3DRotY?

optional v3DRotY?: number

Defined in: core-interfaces.ts:2280

Y Rotation

  • range: 0-359.9

Default

ts
30

Inherited from

IChartPropsBase.v3DRotY


valAxes?

optional valAxes?: IChartPropsAxisVal[]

Defined in: core-interfaces.ts:2397

Multi-Chart prop: array of val axes

Inherited from

IChartPropsAxisVal.valAxes


valAxisCrossBetween?

optional valAxisCrossBetween?: "between" | "midCat"

Defined in: core-interfaces.ts:2405

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

IChartPropsAxisVal.valAxisCrossBetween


valAxisCrossesAt?

optional valAxisCrossesAt?: number | "autoZero"

Defined in: core-interfaces.ts:2398

Inherited from

IChartPropsAxisVal.valAxisCrossesAt


valAxisDisplayUnit?

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

Defined in: core-interfaces.ts:2406

Inherited from

IChartPropsAxisVal.valAxisDisplayUnit


valAxisDisplayUnitLabel?

optional valAxisDisplayUnitLabel?: boolean

Defined in: core-interfaces.ts:2407

Inherited from

IChartPropsAxisVal.valAxisDisplayUnitLabel


valAxisHidden?

optional valAxisHidden?: boolean

Defined in: core-interfaces.ts:2408

Inherited from

IChartPropsAxisVal.valAxisHidden


valAxisLabelColor?

optional valAxisLabelColor?: string

Defined in: core-interfaces.ts:2409

Inherited from

IChartPropsAxisVal.valAxisLabelColor


valAxisLabelFontBold?

optional valAxisLabelFontBold?: boolean

Defined in: core-interfaces.ts:2410

Inherited from

IChartPropsAxisVal.valAxisLabelFontBold


valAxisLabelFontFace?

optional valAxisLabelFontFace?: string

Defined in: core-interfaces.ts:2411

Inherited from

IChartPropsAxisVal.valAxisLabelFontFace


valAxisLabelFontItalic?

optional valAxisLabelFontItalic?: boolean

Defined in: core-interfaces.ts:2412

Inherited from

IChartPropsAxisVal.valAxisLabelFontItalic


valAxisLabelFontSize?

optional valAxisLabelFontSize?: number

Defined in: core-interfaces.ts:2413

Inherited from

IChartPropsAxisVal.valAxisLabelFontSize


valAxisLabelFormatCode?

optional valAxisLabelFormatCode?: string

Defined in: core-interfaces.ts:2414

Inherited from

IChartPropsAxisVal.valAxisLabelFormatCode


valAxisLabelPos?

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

Defined in: core-interfaces.ts:2415

Inherited from

IChartPropsAxisVal.valAxisLabelPos


valAxisLabelRotate?

optional valAxisLabelRotate?: number

Defined in: core-interfaces.ts:2416

Inherited from

IChartPropsAxisVal.valAxisLabelRotate


valAxisLineColor?

optional valAxisLineColor?: string

Defined in: core-interfaces.ts:2417

Inherited from

IChartPropsAxisVal.valAxisLineColor


valAxisLineShow?

optional valAxisLineShow?: boolean

Defined in: core-interfaces.ts:2418

Inherited from

IChartPropsAxisVal.valAxisLineShow


valAxisLineSize?

optional valAxisLineSize?: number

Defined in: core-interfaces.ts:2419

Inherited from

IChartPropsAxisVal.valAxisLineSize


valAxisLineStyle?

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

Defined in: core-interfaces.ts:2420

Inherited from

IChartPropsAxisVal.valAxisLineStyle


valAxisLogScaleBase?

optional valAxisLogScaleBase?: number

Defined in: core-interfaces.ts:2426

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

  • range: 2-99

Since

v3.5.0

Inherited from

IChartPropsAxisVal.valAxisLogScaleBase


valAxisMajorTickMark?

optional valAxisMajorTickMark?: ChartAxisTickMark

Defined in: core-interfaces.ts:2427

Inherited from

IChartPropsAxisVal.valAxisMajorTickMark


valAxisMajorUnit?

optional valAxisMajorUnit?: number

Defined in: core-interfaces.ts:2428

Inherited from

IChartPropsAxisVal.valAxisMajorUnit


valAxisMaxVal?

optional valAxisMaxVal?: number

Defined in: core-interfaces.ts:2429

Inherited from

IChartPropsAxisVal.valAxisMaxVal


valAxisMinorTickMark?

optional valAxisMinorTickMark?: ChartAxisTickMark

Defined in: core-interfaces.ts:2430

Inherited from

IChartPropsAxisVal.valAxisMinorTickMark


valAxisMinVal?

optional valAxisMinVal?: number

Defined in: core-interfaces.ts:2431

Inherited from

IChartPropsAxisVal.valAxisMinVal


valAxisOrientation?

optional valAxisOrientation?: "minMax" | "maxMin"

Defined in: core-interfaces.ts:2432

Inherited from

IChartPropsAxisVal.valAxisOrientation


valAxisTitle?

optional valAxisTitle?: string

Defined in: core-interfaces.ts:2433

Inherited from

IChartPropsAxisVal.valAxisTitle


valAxisTitleColor?

optional valAxisTitleColor?: string

Defined in: core-interfaces.ts:2434

Inherited from

IChartPropsAxisVal.valAxisTitleColor


valAxisTitleFontFace?

optional valAxisTitleFontFace?: string

Defined in: core-interfaces.ts:2435

Inherited from

IChartPropsAxisVal.valAxisTitleFontFace


valAxisTitleFontSize?

optional valAxisTitleFontSize?: number

Defined in: core-interfaces.ts:2436

Inherited from

IChartPropsAxisVal.valAxisTitleFontSize


valAxisTitleRotate?

optional valAxisTitleRotate?: number

Defined in: core-interfaces.ts:2437

Inherited from

IChartPropsAxisVal.valAxisTitleRotate


valGridLine?

optional valGridLine?: OptsChartGridLine

Defined in: core-interfaces.ts:2438

Inherited from

IChartPropsAxisVal.valGridLine


valign?

optional valign?: VAlign

Defined in: core-interfaces.ts:770

vertical alignment

Default

ts
'top'

Inherited from

IChartPropsTitle.valign


valLabelFormatCode?

optional valLabelFormatCode?: string

Defined in: core-interfaces.ts:2447

Value label format code

  • this also directs Data Table formatting

Since

v3.3.0

Examples

ts
'#%' // round percent
ts
'0.00%' // shows values as '0.00%'
ts
'$0.00' // shows values as '$0.00'

Inherited from

IChartPropsAxisVal.valLabelFormatCode


w?

optional w?: Coord

Defined in: core-interfaces.ts:54

Width

  • inches or percentage

Examples

ts
10.25 // width in inches
ts
'75%' // width as percentage of slide size

Inherited from

PositionProps.w


x?

optional x?: Coord

Defined in: core-interfaces.ts:33

Horizontal position

  • inches or percentage

Examples

ts
10.25 // position in inches
ts
'75%' // position as percentage of slide size

Inherited from

PositionProps.x


y?

optional y?: Coord

Defined in: core-interfaces.ts:40

Vertical position

  • inches or percentage

Examples

ts
10.25 // position in inches
ts
'75%' // position as percentage of slide size

Inherited from

PositionProps.y