ts-pptx

Appearance

Interface: TextBulletProps ​

A drawn bullet: the object arm of TextPropsOptions.bullet.

Named rather than left inline so a caller can build one as a variable and so the two relationship ids addText() stamps on it have somewhere off the public surface to live (TextBulletPropsInternal).

Properties ​

characterCode? ​

optional characterCode?: string

Bullet character code (unicode)

Example ​

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

color? ​

optional color?: string

Bullet glyph color (separate from the text run color)

Example ​

ts
'FF0000' // red bullet

fontFace? ​

optional fontFace?: string

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

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) 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

data? ​

optional data?: string

path? ​

optional path?: string

Examples ​

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

indent? ​

optional indent?: number

Indentation (space between bullet and text) (points)

Default ​

ts
27 // DEF_BULLET_MARGIN

Example ​

ts
10 // Indents text 10 points from bullet

numberStartAt? ​

optional numberStartAt?: number

Number bullets start at

Default ​

ts
1

Example ​

ts
10 // numbered bullets start with 10

numberType? ​

optional numberType?: "alphaLcParenBoth" | "alphaUcParenBoth" | "alphaLcParenR" | "alphaUcParenR" | "alphaLcPeriod" | "alphaUcPeriod" | "arabicParenBoth" | "arabicParenR" | "arabicPeriod" | "arabicPlain" | "romanLcParenBoth" | "romanUcParenBoth" | "romanLcParenR" | "romanUcParenR" | "romanLcPeriod" | "romanUcPeriod" | "circleNumDbPlain" | "circleNumWdBlackPlain" | "circleNumWdWhitePlain" | "arabicDbPeriod" | "arabicDbPlain" | "ea1ChsPeriod" | "ea1ChsPlain" | "ea1ChtPeriod" | "ea1ChtPlain" | "ea1JpnChsDbPeriod" | "ea1JpnKorPlain" | "ea1JpnKorPeriod" | "arabic1Minus" | "arabic2Minus" | "hebrew2Minus" | "thaiAlphaPeriod" | "thaiAlphaParenR" | "thaiAlphaParenBoth" | "thaiNumPeriod" | "thaiNumParenR" | "thaiNumParenBoth" | "hindiAlphaPeriod" | "hindiNumPeriod" | "hindiNumParenR" | "hindiAlpha1Period"

Number type: any ST_TextAutonumberScheme (a:buAutoNum/@type)

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)

Default ​

ts
100

Example ​

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

type? ​

optional type?: "number" | "bullet"

Bullet type

Default ​

ts
bullet