PptxGenJS

Appearance

@shbernal/pptxgenjs

@shbernal/pptxgenjs / index / SlideNumberProps

Interface: SlideNumberProps ​

Defined in: core-interfaces.ts:2821

Extends ​

Properties ​

align? ​

optional align?: HAlign

Defined in: core-interfaces.ts:521

Horizontal alignment

Default ​

ts
'left'

Inherited from ​

TextBaseProps.align

bold? ​

optional bold?: boolean

Defined in: core-interfaces.ts:526

Bold style

Default ​

ts
false

Inherited from ​

TextBaseProps.bold

breakLine? ​

optional breakLine?: boolean

Defined in: core-interfaces.ts:531

Add a line-break

Default ​

ts
false

Inherited from ​

TextBaseProps.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 ​

TextBaseProps.bullet

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 ​

TextBaseProps.caps

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 ​

TextBaseProps.color

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 ​

TextBaseProps.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 ​

TextBaseProps.fontFaceEA

fontSize? ​

optional fontSize?: number

Defined in: core-interfaces.ts:694

Font size

Example ​

ts
12 // Font size 12

Inherited from ​

TextBaseProps.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 ​

TextBaseProps.highlight

italic? ​

optional italic?: boolean

Defined in: core-interfaces.ts:704

italic style

Default ​

ts
false

Inherited from ​

TextBaseProps.italic

lang? ​

optional lang?: string

Defined in: core-interfaces.ts:711

language

  • ISO 639-1 standard language code

Default ​

ts
'en-US' // english US

Example ​

ts
'fr-CA' // french Canadian

Inherited from ​

TextBaseProps.lang

margin? ​

optional margin?: Margin

Defined in: core-interfaces.ts:2825

margin (points)

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 ​

TextBaseProps.softBreakBefore

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 ​

TextBaseProps.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 ​

TextBaseProps.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 ​

TextBaseProps.textWarp

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 ​

TextBaseProps.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 ​

TextBaseProps.underline

valign? ​

optional valign?: VAlign

Defined in: core-interfaces.ts:770

vertical alignment

Default ​

ts
'top'

Inherited from ​

TextBaseProps.valign

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