Visio.PageView class
表示 PageView 类。
方法
| center |
平移 Visio 绘图，将指定的形状放置在视图中心位置。 |
| fit |
让页面填满当前窗口。 |
| get |
返回在视图中指定页面位置的 Position 对象。 |
| get |
表示页面中的 Selection 对象。 |
| is |
检查形状是否在页面的视区内。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| set |
在视图中设置页面的位置。 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
zoom
获取并设置页面的缩放级别。 该值可以在 10 到 400 之间，表示缩放百分比。
zoom: number;属性值
number
注解
示例
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
注解
示例
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()
getPosition()
返回在视图中指定页面位置的 Position 对象。
getPosition(): OfficeExtension.ClientResult<Visio.Position>;返回
注解
getSelection()
isShapeInViewport(Shape)
检查形状是否在页面的视区内。
isShapeInViewport(Shape: Visio.Shape): OfficeExtension.ClientResult<boolean>;参数
- Shape
- Visio.Shape
要检查的形状。
返回
OfficeExtension.ClientResult<boolean>
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Visio.Interfaces.PageViewLoadOptions): Visio.PageView;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Visio.PageView;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.PageView;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.PageViewUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Visio.Interfaces.PageViewUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
setPosition(Position)
在视图中设置页面的位置。
setPosition(Position: Visio.Position): void;参数
- Position
- Visio.Position
指定页面在视图中的新位置的位置对象。
返回
void
注解
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来 toJSON 调用传递给它的对象的方法。) 虽然原始 Visio.PageView 对象是一个 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型化为 Visio.Interfaces.PageViewData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Visio.Interfaces.PageViewData;