Visio.Interfaces.PageData interface

An interface describing the data returned by calling "page.toJSON()".

Properties

allShapes

All shapes in the Page, including subshapes. Read-only.

[ API set: 1.1 ]

comments

Returns the Comments Collection. Read-only.

[ API set: 1.1 ]

height

Returns the height of the page. Read-only.

[ API set: 1.1 ]

index

Index of the Page. Read-only.

[ API set: 1.1 ]

isBackground

Whether the page is a background page or not. Read-only.

[ API set: 1.1 ]

name

Page name. Read-only.

[ API set: 1.1 ]

shapes

All top-level shapes in the Page.Read-only.

[ API set: 1.1 ]

view

Returns the view of the page. Read-only.

[ API set: 1.1 ]

width

Returns the width of the page. Read-only.

[ API set: 1.1 ]

Property Details

allShapes

All shapes in the Page, including subshapes. Read-only.

[ API set: 1.1 ]

allShapes?: Visio.Interfaces.ShapeData[];

Property Value

comments

Returns the Comments Collection. Read-only.

[ API set: 1.1 ]

comments?: Visio.Interfaces.CommentData[];

Property Value

height

Returns the height of the page. Read-only.

[ API set: 1.1 ]

height?: number;

Property Value

number

index

Index of the Page. Read-only.

[ API set: 1.1 ]

index?: number;

Property Value

number

isBackground

Whether the page is a background page or not. Read-only.

[ API set: 1.1 ]

isBackground?: boolean;

Property Value

boolean

name

Page name. Read-only.

[ API set: 1.1 ]

name?: string;

Property Value

string

shapes

All top-level shapes in the Page.Read-only.

[ API set: 1.1 ]

shapes?: Visio.Interfaces.ShapeData[];

Property Value

view

Returns the view of the page. Read-only.

[ API set: 1.1 ]

view?: Visio.Interfaces.PageViewData;

Property Value

width

Returns the width of the page. Read-only.

[ API set: 1.1 ]

width?: number;

Property Value

number