Reference

API reference

Every public export of @office-kit/pptx and @office-kit/pptx/node, organized by category. The library is fn-only — no classes — so this list is the entire callable surface. 266 exports across 17 groups.

For the conceptual map and migration notes see the API overview. For copy-pasteable code see the Cheatsheet and Recipes.

01

Load / save

Open and persist a .pptx, plus the Node fs convenience subpath.

5
02

Units

Branded Emu constructors. Internal code only sees Emu — every numeric position is type-checked at the boundary.

5
  • inches (n: number) => Emu
  • cm (n: number) => Emu
  • mm (n: number) => Emu
  • pt (n: number) => Emu
  • emu (n: number) => Emu — escape hatch
03

Slides

Enumerate, add, remove, reorder. Layouts come from the loaded template.

19
04

Slide layouts

Inspect and switch slides between the layouts shipped by the deck's masters.

10
05

Slide metadata

Title, size, visibility, sections, background, transitions, speaker notes.

19
06

Placeholders & text

Find placeholders by type, replace tokens, set per-run / per-paragraph formatting.

28
07

Shapes

Add, find, mutate, remove shapes. 180+ preset geometries.

25
08

Shape geometry

Position, size, rotation, flip, z-order.

20
09

Fill, stroke, effects

Solid / gradient / pattern / image fill + stroke + shadow / glow.

22
10

Images

Embedded picture shapes — bytes, crop, opacity, brightness, contrast.

14
11

Tables

Per-cell text / fill / alignment, structural insert / remove, sizing.

22
12

Charts

Embedded charts with auto-generated xlsx. Kinds: bar, column, line, pie, doughnut, area.

11
14

Animations

Entrance / exit / emphasis presets. Complex timing-tree authoring is post-1.0.

3
15

Comments

Per-slide review comments with author metadata and EMU position.

22
16

Document properties

Title, Author, Subject, Keywords, App, Company, thumbnail.

14
17

Diagnostics

Validation, raw OPC introspection, media accounting.

14