Visio.Document class

参考

包:: visio

表示 Document 类。

扩展: OfficeExtension.ClientObject

注解

属性

application	表示包含此文档的 Visio 应用程序实例。
context	与对象关联的请求上下文。这会将加载项的进程连接到 Office 主机应用程序的进程。
pages	表示一组与文档相关联的页面。
view	返回 DocumentView 对象。

方法

getActivePage()	返回文档的活动页。
load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
set(properties, options)	同时设置对象的多个属性。可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
setActivePage(PageName)	设置文档的活动页。
setMockData(data)	设置模拟数据
showTaskPane(taskPaneType, initialProps, show)	显示或隐藏 TaskPane。这将由嵌入 Visio 绘图以显示/隐藏任务窗格的 DV Excel 外接程序/其他第三方应用使用。
showTaskPane(taskPaneTypeString, initialProps, show)	显示或隐藏 TaskPane。这将由嵌入 Visio 绘图以显示/隐藏任务窗格的 DV Excel 外接程序/其他第三方应用使用。
startDataRefresh()	触发刷新关系图中所有页面的数据。
toJSON()	重写 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 `JSON.stringify` (，反过来，调用`toJSON`传递给它的对象的方法。) 而原始 Visio.Document 对象是 API 对象，`toJSON`该方法返回一个纯 JavaScript 对象， (类型为 `Visio.Interfaces.DocumentData`) ，该对象包含从原始对象加载的任何子属性的浅表副本。

事件

onDataRefreshComplete	在图表中刷新数据时发生。
onDocumentError	在会话中发生预期错误或意外错误时发生。
onDocumentLoadComplete	在加载、刷新或更改文档时发生。
onPageLoadComplete	页面加载完成后发生。
onSelectionChanged	在形状的当前选择发生更改时发生。
onShapeMouseEnter	当用户将鼠标指针移到形状的边界框中时发生。
onShapeMouseLeave	当用户将鼠标移出形状的边界框时发生。
onTaskPaneStateChanged	每当更改任务窗格状态时发生。

属性详细信息

application

表示包含此文档的 Visio 应用程序实例。

readonly application: Visio.Application;

属性值

Visio.Application

注解

[ API 集： 1.1 ]

context

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

context: RequestContext;

属性值

Visio.RequestContext

pages

表示一组与文档相关联的页面。

readonly pages: Visio.PageCollection;

属性值

Visio.PageCollection

注解

[ API 集： 1.1 ]

示例

Visio.run(session, function (ctx) {
    const pages = ctx.document.pages;
    const pageCount = pages.getCount();
    return ctx.sync().then(function () {
        console.log("Pages Count: " +pageCount.value);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

view

返回 DocumentView 对象。

readonly view: Visio.DocumentView;

属性值

Visio.DocumentView

注解

[ API 集： 1.1 ]

方法详细信息

getActivePage()

返回文档的活动页。

getActivePage(): Visio.Page;

Visio.Page

注解

[ API 集： 1.1 ]

示例

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

load(options)

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

load(options?: Visio.Interfaces.DocumentLoadOptions): Visio.Document;

参数

options: Visio.Interfaces.DocumentLoadOptions

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

Visio.Document

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

Visio.Document

load(propertyNamesAndPaths)

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

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

参数

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

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

Visio.Document

set(properties, options)

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

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

参数

properties: Visio.Interfaces.DocumentUpdateData

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

options: OfficeExtension.UpdateOptions

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

void

set(properties)

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

set(properties: Visio.Document): void;

参数

properties: Visio.Document

void

setActivePage(PageName)

设置文档的活动页。

setActivePage(PageName: string): void;

参数

PageName: string

页面的名称

void

注解

[ API 集： 1.1 ]

示例

Visio.run(session, function (ctx) {
    const document = ctx.document;
    const pageName = "Page-1";
    document.setActivePage(pageName);
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

setMockData(data)

设置模拟数据

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

参数

data: Visio.Interfaces.DocumentData

void

showTaskPane(taskPaneType, initialProps, show)

显示或隐藏 TaskPane。这将由嵌入 Visio 绘图以显示/隐藏任务窗格的 DV Excel 外接程序/其他第三方应用使用。

showTaskPane(taskPaneType: Visio.TaskPaneType, initialProps?: any, show?: boolean): void;

参数

taskPaneType: Visio.TaskPaneType

第一方任务窗格的类型。它可以从枚举 TaskPaneType 获取值

initialProps: any

可选参数。这是一个泛型数据结构，它将用初始化任务窗格内容所需的初始数据填充。

show: boolean

可选参数。如果设置为 false，它将隐藏指定的任务窗格。

void

注解

[ API 集： 1.1 ]

showTaskPane(taskPaneTypeString, initialProps, show)

显示或隐藏 TaskPane。这将由嵌入 Visio 绘图以显示/隐藏任务窗格的 DV Excel 外接程序/其他第三方应用使用。

showTaskPane(taskPaneTypeString: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void;

参数

taskPaneTypeString: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings"

第一方任务窗格的类型。它可以从枚举 TaskPaneType 获取值

initialProps: any

可选参数。这是一个泛型数据结构，它将用初始化任务窗格内容所需的初始数据填充。

show: boolean

可选参数。如果设置为 false，它将隐藏指定的任务窗格。

void

注解

[ API 集： 1.1 ]

startDataRefresh()

触发刷新关系图中所有页面的数据。

startDataRefresh(): void;

void

注解

[ API 集： 1.1 ]

示例

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

toJSON()

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

toJSON(): Visio.Interfaces.DocumentData;

Visio.Interfaces.DocumentData

事件详细信息

onDataRefreshComplete

在图表中刷新数据时发生。

readonly onDataRefreshComplete: OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>;

事件类型

OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>

注解

[ API 集： 1.1 ]

onDocumentError

在会话中发生预期错误或意外错误时发生。

readonly onDocumentError: OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>;

事件类型

OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>

注解

[ API 集： 1.1 ]

onDocumentLoadComplete

在加载、刷新或更改文档时发生。

readonly onDocumentLoadComplete: OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>;

事件类型

OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>

注解

[ API 集： 1.1 ]

onPageLoadComplete

页面加载完成后发生。

readonly onPageLoadComplete: OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>;

事件类型

OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>

注解

[ API 集： 1.1 ]

onSelectionChanged

在形状的当前选择发生更改时发生。

readonly onSelectionChanged: OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>;

事件类型

OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>

注解

[ API 集： 1.1 ]

onShapeMouseEnter

当用户将鼠标指针移到形状的边界框中时发生。

readonly onShapeMouseEnter: OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>;

事件类型

OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>

注解

[ API 集： 1.1 ]

onShapeMouseLeave

当用户将鼠标移出形状的边界框时发生。

readonly onShapeMouseLeave: OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>;

事件类型

OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>

注解

[ API 集： 1.1 ]

onTaskPaneStateChanged

每当更改任务窗格状态时发生。

readonly onTaskPaneStateChanged: OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>;

事件类型

OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>

注解

[ API 集： 1.1 ]

通过

Visio.Document class

注解

属性

方法

事件

属性详细信息

application

属性值

注解

context

属性值

pages

属性值

注解

示例

view

属性值

注解

方法详细信息

getActivePage()

返回

注解

示例

load(options)

参数

返回

load(propertyNames)

参数

返回

load(propertyNamesAndPaths)

参数

返回

set(properties, options)

参数

返回

set(properties)

参数

返回

setActivePage(PageName)

参数

返回

注解

示例

setMockData(data)

参数

返回

showTaskPane(taskPaneType, initialProps, show)

参数

返回

注解

showTaskPane(taskPaneTypeString, initialProps, show)

参数

返回

注解

startDataRefresh()

返回

注解

示例

toJSON()

返回

事件详细信息

onDataRefreshComplete

事件类型

注解

onDocumentError

事件类型

注解

onDocumentLoadComplete

事件类型

注解

onPageLoadComplete

事件类型

注解

onSelectionChanged

事件类型

注解

onShapeMouseEnter

事件类型

注解