Visio.Interfaces.PageData interface

Package:

visio

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

Properties

allShapes	All shapes in the Page, including subshapes.
comments	Returns the Comments Collection.
height	Returns the height of the page.
index	Index of the Page.
isBackground	Whether the page is a background page or not.
name	Page name.
shapes	All top-level shapes in the Page.
view	Returns the view of the page.
width	Returns the width of the page.

Property Details

allShapes

All shapes in the Page, including subshapes.

allShapes?: Visio.Interfaces.ShapeData[];

Property Value

Visio.Interfaces.ShapeData[]

Remarks

[ API set: 1.1 ]

comments

Returns the Comments Collection.

comments?: Visio.Interfaces.CommentData[];

Property Value

Visio.Interfaces.CommentData[]

Remarks

[ API set: 1.1 ]

height

Returns the height of the page.

height?: number;

Property Value

number

Remarks

[ API set: 1.1 ]

index

Index of the Page.

index?: number;

Property Value

number

Remarks

[ API set: 1.1 ]

isBackground

Whether the page is a background page or not.

isBackground?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]

name

Page name.

name?: string;

Property Value

string

Remarks

[ API set: 1.1 ]

shapes

All top-level shapes in the Page.

shapes?: Visio.Interfaces.ShapeData[];

Property Value

Visio.Interfaces.ShapeData[]

Remarks

[ API set: 1.1 ]

view

Returns the view of the page.

view?: Visio.Interfaces.PageViewData;

Property Value

Visio.Interfaces.PageViewData

Remarks

[ API set: 1.1 ]

width

Returns the width of the page.

width?: number;

Property Value

number

Remarks

[ API set: 1.1 ]