Page object (JavaScript API for Visio)

Applies to: Visio Online

Represents the Page class.

Properties

Property Type Description
height int Returns the height of the page. Read-only.
index int Index of the Page. Read-only.
isBackground bool Whether the page is a background page or not. Read-only.
name string Page name. Read-only.
width int Returns the width of the page. Read-only.

Relationships

Relationship Type Description
comments CommentCollection Returns the Comments Collection. Read-only.
shapes ShapeCollection Shapes in the Page. Read-only.
view PageView Returns the view of the page. Read-only.

Methods

Method Return Type Description
activate() void Set the page as Active Page of the document.
load(param: object) void Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.

Method Details

activate()

Set the page as Active Page of the document.

Syntax

pageObject.activate();

Parameters

None

Returns

void

load(param: object)

Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.

Syntax

object.load(param);

Parameters

Parameter Type Description  
param object Optional. Accepts parameter and relationship names as delimited string or an array. Or, provide loadOption object.  

Returns

void

eated in JavaScript layer with property and object values specified in the parameter.

Syntax

object.load(param);

Parameters

Parameter Type Description  
param object Optional. Accepts parameter and relationship names as delimited string or an array. Or, provide loadOption object.  

Returns

void