optional bullet?: boolean | "inherit" | { 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: src/types/text.ts:53

Add standard or custom bullet

use true for standard bullet
pass object options for custom bullet
false (and omitting the option) is the explicit off: it writes <a:buNone/> plus marL="0" indent="0", which overrides whatever bullet the layout's or master's list style sets for this level
'inherit' states nothing at all — no bullet child and no margin attributes — so the list style keeps reaching the paragraph. This is the one state omission cannot spell, because omitting the option means false here for compatibility

The margins are only a default of the bullet state: paraMarginLeft and paraIndent state @marL/@indent independently in any of the three, including an inherited margin under a drawn bullet.

Union Members

boolean

"inherit"

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

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

Example

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

type?

optional type?: "number" | "bullet"

Bullet type

Default

bullet

Default

false

Inherited from

TextBaseProps.bullet

caps?

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

Defined in: src/types/text.ts:149

Text capitalization (a:rPr/@cap, ST_TextCapsType)

'all' = ALL CAPS
'small' = Small Caps
'none' = the explicit off: it writes cap="none", which overrides a capitalization the run would otherwise inherit. Omitting the option states nothing and lets that inheritance stand
PowerPoint: Font > Effects > All Caps / Small Caps

Default

(unset) inherit

Inherited from

TextBaseProps.caps

color?

optional color?: string

Defined in: src/types/text.ts:157

Text color

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

Examples

'FF0000' // hex color (red)

SchemeColor.text1 // Theme color (Text1)

Inherited from

TextBaseProps.color

fontFace?

optional fontFace?: string

Defined in: src/types/text.ts:167

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

TextBaseProps.fontFace

fontFaceEA?

optional fontFaceEA?: string

Defined in: src/types/text.ts:175

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

TextBaseProps.fontFaceEA

fontSize?

optional fontSize?: number

Defined in: src/types/text.ts:180

Font size

Example

12 // Font size 12

Inherited from

TextBaseProps.fontSize

h?

optional h?: Coord

Defined in: src/types/core.ts:49

Height

inches or percentage

Examples

10.25 // height in inches

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

Inherited from

PositionProps.h

highlight?

optional highlight?: string

Defined in: src/types/text.ts:185

Text highlight color (hex format)

Example

'FFFF00' // yellow

Inherited from

TextBaseProps.highlight

italic?

optional italic?: boolean

Defined in: src/types/text.ts:190

italic style

Default

false

Inherited from

TextBaseProps.italic

lang?

optional lang?: string

Defined in: src/types/text.ts:197

language

ISO 639-1 standard language code

Default

'en-US' // english US

Example

'fr-CA' // french Canadian

Inherited from

TextBaseProps.lang

margin?

optional margin?: Margin

Defined in: src/types/object.ts:16

margin (inches) — text-frame internal margin; a value >= 1 warns as a likely legacy points value

name

name: string

Defined in: src/types/object.ts:11

objectLock?

optional objectLock?: ObjectLockProps

Defined in: src/types/object.ts:54

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

ObjectNameProps.objectLock

objectName?

optional objectName?: string

Defined in: src/types/object.ts:36

Object name

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

Default

'Object 1'

Example

'Antenna Design 9'

Inherited from

ObjectNameProps.objectName

paraIndent?

optional paraIndent?: number | "inherit"

Defined in: src/types/text.ts:214

First-line indent (points) — a:pPr/@indent, the offset of the paragraph's FIRST line from paraMarginLeft. Negative hangs the first line to the left of the body, which is what a bulleted paragraph does; positive indents it to the right, the "first line indented" prose form. PowerPoint: Paragraph > Indentation > Special.

'inherit' writes no @indent at all, so the paragraph takes whatever its list style (a:lstStyle → placeholder → layout → master) sets — the same third state bullet spells, on the attribute beside it
omitting the option keeps the bullet-derived default: a drawn bullet hangs the first line by its margin, bullet: false writes indent="0", bullet: 'inherit' writes nothing
a value here overrides all of those, in every bullet state

Examples

-18 // hang the first line 18pt left of the body text

18 // indent the first line 18pt, prose style

'inherit' // keep the list style's indent, even on a bulleted paragraph

Inherited from

TextBaseProps.paraIndent

paraMarginLeft?

optional paraMarginLeft?: number | "inherit"

Defined in: src/types/text.ts:229

Left margin of the paragraph (points) — a:pPr/@marL, where the paragraph's body text starts. This is the paragraph's own margin, not the text frame's internal padding (margin) and not the discrete outline level (indentLevel, which writes a:p/@lvl). PowerPoint: Paragraph > Indentation > Before text.

'inherit' writes no @marL at all, so the paragraph takes whatever its list style (a:lstStyle → placeholder → layout → master) sets — the third state that omission cannot spell, since omitting it writes the bullet-derived default
omitting the option keeps that default: a drawn bullet writes its own margin (see bullet.indent), bullet: false writes marL="0", bullet: 'inherit' writes nothing
a value here overrides all of those, in every bullet state

Examples

36 // body text starts 36pt (0.5in) from the frame's text edge

'inherit' // keep the list style's margin, even on a bulleted paragraph

Inherited from

TextBaseProps.paraMarginLeft

rectRadius?

optional rectRadius?: number

Defined in: src/types/object.ts:26

Rounded rectangle corner radius (inches) when shape: 'roundRect'

range: 0.0 to slide height/2

shape?

optional shape?: SHAPE_NAME

Defined in: src/types/object.ts:21

Preset shape geometry for this placeholder (e.g. 'roundRect')

Default

'rect'

softBreakBefore?

optional softBreakBefore?: boolean

Defined in: src/types/text.ts:234

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

Default

false

Inherited from

TextBaseProps.softBreakBefore

tabStops?

optional tabStops?: object[]

Defined in: src/types/text.ts:240

tab stops

PowerPoint: Paragraph > Tabs > Tab stop position

alignment?

optional alignment?: "r" | "ctr" | "l" | "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

TextBaseProps.tabStops

textDirection?

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

Defined in: src/types/text.ts:249

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

Default

'horz'

Inherited from

TextBaseProps.textDirection

textWarp?

optional textWarp?: string

Defined in: src/types/text.ts:36

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

TextBaseProps.textWarp

transparency?

optional transparency?: number

Defined in: src/types/text.ts:256

Transparency (percent)

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

Default

Inherited from

TextBaseProps.transparency

type

type: "media" | "body" | "title" | "chart" | "pic" | "tbl"

Defined in: src/types/object.ts:12

underline?

optional underline?: object

Defined in: src/types/text.ts:267

underline properties

PowerPoint: Font > Color & Underline > Underline Style/Underline Color
style is the full ST_TextUnderlineType enumeration (ECMA-376 §20.1.10.81)
'none' is the explicit off: it writes a:rPr/@u="none", which overrides an underline the run would otherwise inherit from its list style, placeholder, layout or master. Omitting the option instead states nothing and lets that inheritance stand — the two are different facts, not two spellings of one.

color?

optional color?: string

style?

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

Default

(unset) inherit

Inherited from

TextBaseProps.underline

valign?

optional valign?: VAlign

Defined in: src/types/text.ts:293

vertical alignment

Default

'top'

Inherited from

TextBaseProps.valign

w?

optional w?: Coord

Defined in: src/types/core.ts:56

Width

inches or percentage

Examples

10.25 // width in inches

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

Inherited from

PositionProps.w

x?

optional x?: Coord

Defined in: src/types/core.ts:35

Horizontal position

inches or percentage

Examples

10.25 // position in inches

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

Inherited from

PositionProps.x

y?

optional y?: Coord

Defined in: src/types/core.ts:42

Vertical position

inches or percentage

Examples

10.25 // position in inches

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

Inherited from

PositionProps.y

Interface: PlaceholderProps ​

Extends ​

Properties ​

align? ​

Default ​

Inherited from ​

altText? ​

Example ​

Inherited from ​

bold? ​

Default ​

Inherited from ​

breakLine? ​

Default ​

Inherited from ​

bullet? ​

Union Members ​

Type Literal ​

characterCode? ​

Example ​

color? ​

Example ​

fontFace? ​

Example ​

image? ​

Examples ​

image.data? ​

image.path? ​

indent? ​

Default ​

Example ​

numberStartAt? ​

Default ​

Example ​

numberType? ​

Example ​

size? ​

Default ​

Example ​

type? ​

Default ​

Default ​

Inherited from ​

caps? ​

Default ​

Inherited from ​

color? ​

Examples ​

Inherited from ​

fontFace? ​

Example ​

Inherited from ​

fontFaceEA? ​

Example ​

Inherited from ​

fontSize? ​

Example ​

Inherited from ​

h? ​

Examples ​

Inherited from ​

highlight? ​

Example ​

Inherited from ​

italic? ​

Default ​

Inherited from ​

lang? ​

Default ​

Example ​

Inherited from ​

margin? ​

name ​

objectLock? ​

Examples ​

Inherited from ​

objectName? ​

Default ​

Example ​

Inherited from ​

Interface: PlaceholderProps

Extends

Properties

align?

Default

Inherited from

altText?

Example

Inherited from

bold?

Default

Inherited from

breakLine?

Default

Inherited from

bullet?

Union Members

Type Literal

characterCode?

Example

color?

Example

fontFace?

Example

image?

Examples

image.data?

image.path?

indent?

Default

Example

numberStartAt?

Default

Example

numberType?

Example

size?

Default

Example

type?

Default

Default

Inherited from

caps?

Default

Inherited from

color?

Examples

Inherited from

fontFace?

Example

Inherited from

fontFaceEA?

Example

Inherited from

fontSize?

Example

Inherited from

h?

Examples

Inherited from

highlight?

Example

Inherited from

italic?

Default

Inherited from

lang?

Default

Example

Inherited from

margin?

name

objectLock?

Examples

Inherited from

objectName?

Default

Example

Inherited from