Visio.PageView class

包:

visio

表示 PageView 类。

扩展

OfficeExtension.ClientObject

注解

[ API 集： 1.1 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
zoom	获取并设置页面的缩放级别。 该值可以介于 10 到 400 之间，表示缩放的百分比。

方法

centerViewportOnShape(ShapeId)	平移 Visio 绘图，将指定的形状放置在视图中心位置。
fitToWindow()	让页面填满当前窗口。
getPosition()	返回在视图中指定页面位置的 Position 对象。
getSelection()	表示页面中的 Selection 对象。
isShapeInViewport(Shape)	检查形状是否在页面的视区内。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)	同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
setMockData(data)	设置模拟数据
setPosition(Position)	在视图中设置页面的位置。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始 Visio.PageView 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Visio.Interfaces.PageViewData) ，该对象包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Visio.RequestContext

zoom

获取并设置页面的缩放级别。 该值可以介于 10 到 400 之间，表示缩放的百分比。

zoom: number;

属性值

number

注解

[ API 集： 1.1 ]

示例

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    activePage.view.zoom = 300;
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

方法详细信息

centerViewportOnShape(ShapeId)

平移 Visio 绘图，将指定的形状放置在视图中心位置。

centerViewportOnShape(ShapeId: number): void;

参数

ShapeId

number

在中心位置显示的形状的 ID。

返回

void

注解

[ API 集： 1.1 ]

示例

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    activePage.view.centerViewportOnShape(shape.Id);
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

fitToWindow()

让页面填满当前窗口。

fitToWindow(): void;

返回

void

注解

[ API 集： 1.1 ]

getPosition()

返回在视图中指定页面位置的 Position 对象。

getPosition(): OfficeExtension.ClientResult<Visio.Position>;

返回

OfficeExtension.ClientResult<Visio.Position>

注解

[ API 集： 1.1 ]

getSelection()

表示页面中的 Selection 对象。

getSelection(): Visio.Selection;

返回

Visio.Selection

注解

[ API 集： 1.1 ]

isShapeInViewport(Shape)

检查形状是否在页面的视区内。

isShapeInViewport(Shape: Visio.Shape): OfficeExtension.ClientResult<boolean>;

参数

Shape

Visio.Shape

要检查的形状。

返回

OfficeExtension.ClientResult<boolean>

注解

[ API 集： 1.1 ]

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Visio.Interfaces.PageViewLoadOptions): Visio.PageView;

参数

options

Visio.Interfaces.PageViewLoadOptions

提供要加载对象的属性的选项。

返回

Visio.PageView

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Visio.PageView;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Visio.PageView

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Visio.PageView;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Visio.PageView

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.PageViewUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties

Visio.Interfaces.PageViewUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options

OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Visio.PageView): void;

参数

properties

Visio.PageView

返回

void

setMockData(data)

设置模拟数据

setMockData(data: Visio.Interfaces.PageViewData): void;

参数

data

Visio.Interfaces.PageViewData

返回

void

setPosition(Position)

在视图中设置页面的位置。

setPosition(Position: Visio.Position): void;

参数

Position

Visio.Position

指定页面在视图中的新位置的位置对象。

返回

void

注解

[ API 集： 1.1 ]

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始 Visio.PageView 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Visio.Interfaces.PageViewData) ，该对象包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Visio.Interfaces.PageViewData;

返回

Visio.Interfaces.PageViewData