ts-pptx

Appearance

Interface: SlideZoomProps ​

Slide Zoom: a tile that zooms to a single target slide.

Extends ​

Properties ​

coverImage? ​

optional coverImage?: object

Ship a caller-supplied thumbnail instead of the gray placeholder — a raster image path (Node/local) or base64 data: URI. Shown as-authored (not auto-refreshed by PowerPoint).

data? ​

optional data?: string

path? ​

optional path?: string

Inherited from ​

ZoomBaseProps.coverImage

h? ​

optional h?: Coord

Height

  • inches or percentage

Examples ​

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

Inherited from ​

ZoomBaseProps.h

objectLock? ​

optional objectLock?: ObjectLockProps

Object lock flags (ObjectLockProps), as objectLock on every other object type.

A zoom is a p:graphicFrame, so these land on its a:graphicFrameLocks and the flags that apply are the graphic-frame ones (noGrp, noDrilldown, noSelect, noChangeAspect, noMove, noResize); a picture-only flag warns and is dropped, as everywhere else. The mc:Fallback picture keeps its own fixed lock set — it is what pre-2016 consumers draw, and folding a graphic-frame flag set onto a a:picLocks element would warn about every flag the two element types do not share.

noChangeAspect is on by default (a zoom tile mirrors its target slide's aspect); pass it false to lift it.

Example ​

ts
{ noMove: true, noResize: true } // pin the tile in place

Inherited from ​

ZoomBaseProps.objectLock

objectName? ​

optional objectName?: string

Object name (PowerPoint selection-pane label). Auto-named (e.g. Slide Zoom 3) when omitted.

Inherited from ​

ZoomBaseProps.objectName

returnToParent? ​

optional returnToParent?: boolean

After the zoom animates to its target, return to this (parent) slide when the target's content finishes. Maps to zmPr@returnToParent. Default false.

Inherited from ​

ZoomBaseProps.returnToParent

target ​

target: number | Slide

Target slide — a Slide returned by addSlide(), or its 1-based slide number.

transitionDur? ​

optional transitionDur?: number

Zoom transition duration in milliseconds (zmPr@transitionDur). Default 1000.

Inherited from ​

ZoomBaseProps.transitionDur

w? ​

optional w?: Coord

Width

  • inches or percentage

Examples ​

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

Inherited from ​

ZoomBaseProps.w

x? ​

optional x?: Coord

Horizontal position

  • inches or percentage

Examples ​

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

Inherited from ​

ZoomBaseProps.x

y? ​

optional y?: Coord

Vertical position

  • inches or percentage

Examples ​

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

Inherited from ​

ZoomBaseProps.y