Class Page

Represents a single page (tab) inside a Visio document.

Obtain a Page instance from VisioDocument.pages, VisioDocument.addPage, or VisioDocument.getPage.

Example

const doc  = await VisioDocument.create();
const page = doc.pages[0];
await page.addShape({ text: 'Hello', x: 1, y: 1, width: 2, height: 1 });

Constructors

constructor

new Page(
    internalPage: VisioPage,
    pkg: VisioPackage,
    media?: MediaManager,
    rels?: RelsManager,
    modifier?: ShapeModifier,
): Page
Parameters
- internalPage: VisioPage
- pkg: VisioPackage
- Optionalmedia: MediaManager
- Optionalrels: RelsManager
- Optionalmodifier: ShapeModifier
Returns Page
- Defined in Page.ts:37

Accessors

id

get id(): string
Returns string
- Defined in Page.ts:53

name

get name(): string
Returns string
- Defined in Page.ts:57

orientation

get orientation(): PageOrientation
Current page orientation derived from the canvas dimensions.

Returns PageOrientation
- Defined in Page.ts:72

pageHeight

get pageHeight(): number
Height of the page canvas in inches.

Returns number
- Defined in Page.ts:67

pageWidth

get pageWidth(): number
Width of the page canvas in inches.

Returns number
- Defined in Page.ts:62

Methods

addContainer

addContainer(props: NewShapeProps): Promise<Shape>
Parameters
- props: NewShapeProps
Returns Promise<Shape>
- Defined in Page.ts:283

addImage

addImage(
    data: Buffer,
    name: string,
    x: number,
    y: number,
    width: number,
    height: number,
): Promise<Shape>
Embed an image on the page and return the resulting Foreign shape.
Parameters
- data: Buffer
  Raw image bytes (PNG, JPEG, GIF, BMP, or TIFF).
- name: string
  Filename used to store the image inside the archive (e.g. 'logo.png').
- x: number
  Horizontal pin position in inches.
- y: number
  Vertical pin position in inches.
- width: number
  Display width in inches.
- height: number
  Display height in inches.
Returns Promise<Shape>
Example
```
import fs from 'fs';
const imgBuffer = fs.readFileSync('./logo.png');
await page.addImage(imgBuffer, 'logo.png', 1, 1, 2, 1);
```
- Defined in Page.ts:259

addLayer

addLayer(
name: string,
options?: { lock?: boolean; print?: boolean; visible?: boolean },
): Promise<Layer>
Parameters
- name: string
- Optionaloptions: { lock?: boolean; print?: boolean; visible?: boolean }
Returns Promise<Layer>
- Defined in Page.ts:331

addList

addList(
props: NewShapeProps,
direction?: "vertical" | "horizontal",
): Promise<Shape>
Parameters
- props: NewShapeProps
- direction: "vertical" | "horizontal" = 'vertical'
Returns Promise<Shape>
- Defined in Page.ts:300

addShape

addShape(props: NewShapeProps, parentId?: string): Promise<Shape>

Add a new shape to the page and return a Shape handle to it.

Parameters

props: NewShapeProps
Visual and text properties for the new shape. All geometry fields (x, y, width, height) are in inches.
OptionalparentId: string
Optional ID of an existing group shape to nest the new shape inside.

Returns Promise<Shape>

Example

// Plain rectangle
const box = await page.addShape({ text: 'Server', x: 2, y: 3, width: 2, height: 1 });

// Ellipse with styling
await page.addShape({
    text: 'Start', x: 1, y: 1, width: 1.5, height: 1.5,
    geometry: 'ellipse', fillColor: '#4472C4', fontColor: '#ffffff',
});

// Master instance (shape defined by a reusable master)
const m = doc.createMaster('Router', 'ellipse');
await page.addShape({ text: '', x: 4, y: 2, width: 1, height: 1, masterId: m.id });

addSwimlaneLane

addSwimlaneLane(pool: Shape, props: NewShapeProps): Promise<Shape>
Creates a Swimlane Lane (a Container inside a pool) and attaches it to the pool.
Parameters
- pool: Shape
- props: NewShapeProps
Returns Promise<Shape>
- Defined in Page.ts:323

addSwimlanePool

addSwimlanePool(props: NewShapeProps): Promise<Shape>
Creates a Swimlane Pool (a vertical List of Containers).
Parameters
- props: NewShapeProps
Returns Promise<Shape>
- Defined in Page.ts:318

addTable

addTable(x: number, y: number, title: string, columns: string[]): Promise<Shape>
Parameters
- x: number
- y: number
- title: string
- columns: string[]
Returns Promise<Shape>
- Defined in Page.ts:327

clearDrawingScale

clearDrawingScale(): this
Remove any custom drawing scale, reverting the page to a 1:1 ratio.

Returns this
- Defined in Page.ts:389

connectShapes

connectShapes(
    fromShape: Shape,
    toShape: Shape,
    beginArrow?: string,
    endArrow?: string,
    style?: ConnectorStyle,
    fromPort?: ConnectionTarget,
    toPort?: ConnectionTarget,
): Promise<void>
Draw a connector (line/arrow) between two shapes on this page.
Parameters
- fromShape: Shape
  Source shape.
- toShape: Shape
  Target shape.
- OptionalbeginArrow: string
  Arrow head at the source end (use ArrowHeads constants).
- OptionalendArrow: string
  Arrow head at the target end (use ArrowHeads constants).
- Optionalstyle: ConnectorStyle
  Line color, weight, pattern, and routing style.
- OptionalfromPort: ConnectionTarget
  Named connection point on the source shape (e.g. 'Right').
- OptionaltoPort: ConnectionTarget
  Named connection point on the target shape (e.g. 'Left').
Returns Promise<void>
Example
```
import { ArrowHeads } from 'ts-visio';
const a = await page.addShape({ text: 'A', x: 1, y: 1, width: 1, height: 1 });
const b = await page.addShape({ text: 'B', x: 4, y: 1, width: 1, height: 1 });
await page.connectShapes(a, b, ArrowHeads.None, ArrowHeads.OpenArrow,
    { lineColor: '#333333', routing: 'orthogonal' });
```
- Defined in Page.ts:230

findShapes

findShapes(predicate: (shape: Shape) => boolean): Shape[]
Return all shapes on the page (including nested group children) that satisfy the predicate. Equivalent to getAllShapes().filter(predicate).
Parameters
- predicate: (shape: Shape) => boolean
Returns Shape[]
- Defined in Page.ts:141

getConnectors

getConnectors(): Connector[]
Return all connector shapes on the page. Each Connector exposes the from/to shape IDs, port targets, line style, arrows, and a delete() method to remove the connector.

Returns Connector[]
- Defined in Page.ts:199

getDrawingScale

getDrawingScale(): DrawingScaleInfo | null
Return the current drawing scale, or null if no custom scale is set (1:1).

Returns DrawingScaleInfo | null
Example
```
const scale = page.getDrawingScale();
// { pageScale: 1, pageUnit: 'in', drawingScale: 10, drawingUnit: 'ft' }
```
- Defined in Page.ts:363

getLayers

getLayers(): Layer[]
Return all layers defined on this page, ordered by index. Works for both newly created documents and loaded .vsdx files.

Returns Layer[]
Example
```
const layers = page.getLayers();
// [{ name: 'Background', index: 0, visible: true, locked: false }, ...]
```
- Defined in Page.ts:349

getShapeById

getShapeById(id: string): Shape | undefined
Find a shape by its ID anywhere on the page, including shapes nested inside groups. Returns undefined if no shape with that ID exists.
Parameters
- id: string
Returns Shape | undefined
- Defined in Page.ts:130

getShapes

getShapes(): Shape[]
Return all top-level shapes on the page. Group children are not included; use findShapes to search the entire shape tree.

Returns Shape[]
- Defined in Page.ts:115

setDrawingScale

setDrawingScale(
    pageScale: number,
    pageUnit: LengthUnit,
    drawingScale: number,
    drawingUnit: LengthUnit,
): this
Set a custom drawing scale for the page. One pageScale pageUnit on paper equals drawingScale drawingUnit in the real world.
Parameters
- pageScale: number
- pageUnit: LengthUnit
- drawingScale: number
- drawingUnit: LengthUnit
Returns this
Example
```
// 1 inch on paper = 10 feet in the real world
page.setDrawingScale(1, 'in', 10, 'ft');

// 1:100 metric
page.setDrawingScale(1, 'cm', 100, 'cm');
```
- Defined in Page.ts:378

setNamedSize

setNamedSize(
sizeName: "Letter" | "Legal" | "Tabloid" | "A3" | "A4" | "A5",
orientation?: PageOrientation,
): this
Convenience: change the page to a named standard size (portrait by default).
Parameters
- sizeName: "Letter" | "Legal" | "Tabloid" | "A3" | "A4" | "A5"
- orientation: PageOrientation = 'portrait'
Returns this
Example
```
page.setNamedSize('A4')
```
- Defined in Page.ts:89

setOrientation

setOrientation(orientation: PageOrientation): this
Rotate the canvas between portrait and landscape without changing the paper size. Swaps width and height when the current orientation does not match the requested one.
Parameters
- orientation: PageOrientation
Returns this
- Defined in Page.ts:100

setSize

setSize(width: number, height: number): this
Set the page canvas size in inches.
Parameters
- width: number
- height: number
Returns this
Example
```
page.setSize(11, 8.5)  // landscape letter
```
- Defined in Page.ts:80

Class Page

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Page

Accessors

id

Returns string

name

Returns string

orientation

Returns PageOrientation

pageHeight

Returns number

pageWidth

Returns number

Methods

addContainer

Parameters

Returns Promise<Shape>

addImage

Parameters

Returns Promise<Shape>

Example

addLayer

Parameters

Returns Promise<Layer>

addList

Parameters

Returns Promise<Shape>

addShape

Parameters

Returns Promise<Shape>

Example

addSwimlaneLane

Parameters

Returns Promise<Shape>

addSwimlanePool

Parameters

Returns Promise<Shape>

addTable

Parameters

Returns Promise<Shape>

clearDrawingScale

Returns this

connectShapes

Parameters

Returns Promise<void>

Example

findShapes

Parameters

Returns Shape[]

getConnectors

Returns Connector[]

getDrawingScale

Returns DrawingScaleInfo | null

Example

getLayers

Returns Layer[]

Example

getShapeById

Parameters

Returns Shape | undefined

getShapes

Returns Shape[]

setDrawingScale

Parameters

Returns this

Example

setNamedSize

Parameters

Returns this

Example

setOrientation

Parameters