ts-pptx

Appearance

@shbernal/ts-pptx

@shbernal/ts-pptx / index / Slide

Interface: Slide ​

Defined in: src/types/slide.ts:100

Properties ​

addAnimation ​

addAnimation: (options) => Slide

Defined in: src/types/slide.ts:115

Parameters ​

options ​

AnimationProps

Returns ​

Slide

addComment ​

addComment: (options) => Slide

Defined in: src/types/slide.ts:110

Parameters ​

options ​

CommentProps

Returns ​

Slide

addConnector ​

addConnector: (options) => Slide

Defined in: src/types/slide.ts:103

Parameters ​

options ​

ConnectorProps

Returns ​

Slide

addGroup ​

addGroup: (children, options?) => Slide

Defined in: src/types/slide.ts:117

Group child object descriptors into a single PowerPoint group (<p:grpSp>).

Parameters ​

children ​

GroupChildProps[]

options? ​

GroupProps

Returns ​

Slide

addImage ​

addImage: (options) => Slide

Defined in: src/types/slide.ts:104

Parameters ​

options ​

ImageProps

Returns ​

Slide

addMedia ​

addMedia: (options) => Slide

Defined in: src/types/slide.ts:105

Parameters ​

options ​

MediaProps

Returns ​

Slide

addModel3d ​

addModel3d: (options) => Slide

Defined in: src/types/slide.ts:107

Embed a 3D model (Insert ▸ 3D Models) — a .glb PowerPoint 2019+ renders live.

Parameters ​

options ​

Model3dProps

Returns ​

Slide

addNotes ​

addNotes: (notes) => Slide

Defined in: src/types/slide.ts:111

Parameters ​

notes ​

string | NotesProps | NotesProps[]

Returns ​

Slide

addOleObject ​

addOleObject: (options) => Slide

Defined in: src/types/slide.ts:109

Embed an OLE object (Insert ▸ Object) whose bytes travel inside the .pptx.

Parameters ​

options ​

OleObjectProps

Returns ​

Slide

addShape ​

addShape: (shapeName, options?) => Slide

Defined in: src/types/slide.ts:112

Parameters ​

shapeName ​

SHAPE_NAME

options? ​

ShapeProps

Returns ​

Slide

addTable ​

addTable: (tableRows, options?) => Slide

Defined in: src/types/slide.ts:113

Parameters ​

tableRows ​

TableRow[]

options? ​

TableProps

Returns ​

Slide

addText ​

addText: (text, options?) => Slide

Defined in: src/types/slide.ts:114

Parameters ​

text ​

string | number | TextProps[]

options? ​

TextPropsOptions

Returns ​

Slide

background? ​

optional background?: BackgroundProps

Defined in: src/types/slide.ts:148

Background color or image (color | path | data)

Examples ​

ts
{ color: 'FF3399' } - hex color
ts
{ color: 'FF3399', transparency:50 } - hex color with 50% transparency
ts
{ path: 'https://onedrives.com/myimg.png` } - retrieve image via URL
	 * @example { path: '/home/user/images/myimg.png` } - retrieve image via local path
	 * @example { data: 'image/png;base64,iVtDaDrF[...]=' } - base64 string

color? ​

optional color?: string

Defined in: src/types/slide.ts:154

Default text color (hex format)

Example ​

ts
'FF3399'

Default ​

ts
'000000' (DEF_FONT_COLOR)

groupObjects ​

groupObjects: (objectNames, options?) => Slide

Defined in: src/types/slide.ts:119

Group objects already on this slide, addressed by their objectName, into a single group.

Parameters ​

objectNames ​

string[]

options? ​

GroupProps

Returns ​

Slide

height? ​

readonly optional height?: number

Defined in: src/types/slide.ts:138

Slide height in inches, resolved from the active presentation layout.

hidden? ​

optional hidden?: boolean

Defined in: src/types/slide.ts:159

Whether slide is hidden

Default ​

ts
false

newAutoPagedSlides? ​

readonly optional newAutoPagedSlides?: Slide[]

Defined in: src/types/slide.ts:121

slideNumber? ​

optional slideNumber?: SlideNumberProps

Defined in: src/types/slide.ts:163

Slide number options

transition? ​

optional transition?: TransitionProps

Defined in: src/types/slide.ts:127

Slide-show transition played when advancing to this slide (p:transition).

Example ​

ts
slide.transition = { type: 'fade', durationMs: 1500 }

width? ​

readonly optional width?: number

Defined in: src/types/slide.ts:134

Slide width in inches, resolved from the active presentation layout. Use for coordinate math instead of hard-coding layout dimensions.

Example ​

ts
slide.addText('Centered', { x: 0, w: slide.width, align: 'center' })

Methods ​

addChart() ​

Call Signature ​

addChart(data, options): Slide

Defined in: src/types/slide.ts:101

Parameters ​
data ​

OptsChartData[]

options ​

ChartOpts & object

Returns ​

Slide

Call Signature ​

addChart(charts, options?): Slide

Defined in: src/types/slide.ts:102

Parameters ​
charts ​

ChartMulti[]

options? ​

ChartOpts

Returns ​

Slide