visio package

类

Visio.Application	表示 Application。
Visio.Comment	表示 Comment 对象。
Visio.CommentCollection	表示给定形状的 CommentCollection 对象。
Visio.Document	表示 Document 类。
Visio.DocumentView	表示 DocumentView 类。
Visio.Hyperlink	表示 Hyperlink 对象。
Visio.HyperlinkCollection	表示 HyperlinkCollection 对象。
Visio.Page	表示 Page 类。
Visio.PageCollection	表示属于文档的 Page 对象的集合。
Visio.PageView	表示 PageView 类。
Visio.RequestContext	RequestContext 对象可方便对 Visio 应用程序提出请求。 由于 Office 加载项和 Visio 应用程序在两个不同的进程中运行，因此需要请求上下文才能从加载项访问 Visio 对象模型。
Visio.Selection	表示页面中的 Selection 对象。
Visio.Shape	表示 Shape 类。
Visio.ShapeCollection	表示 Shape 集合。
Visio.ShapeDataItem	表示 ShapeDataItem 对象。
Visio.ShapeDataItemCollection	表示给定形状的 ShapeDataItemCollection 对象。
Visio.ShapeView	表示 ShapeView 类。

接口

Visio.BoundingBox	表示形状的 BoundingBox 对象。
Visio.DataRefreshCompleteEventArgs	提供有关引发了 DataRefreshComplete 事件的文档的信息。
Visio.DocumentErrorEventArgs	提供有关 DocumentError 事件的信息。
Visio.DocumentLoadCompleteEventArgs	提供有关 DocumentLoadComplete 事件成功或失败的信息。
Visio.Highlight	表示添加到形状的突出显示数据。
Visio.Interfaces.ApplicationData	一个描述通过调用 application.toJSON()返回的数据的接口。
Visio.Interfaces.ApplicationLoadOptions	表示 Application。
Visio.Interfaces.ApplicationUpdateData	用于更新 Application 对象上的数据的接口，用于 application.set({ ... }).
Visio.Interfaces.CollectionLoadOptions	提供仅加载集合成员子集的属性的方法。
Visio.Interfaces.CommentCollectionData	一个描述通过调用 commentCollection.toJSON()返回的数据的接口。
Visio.Interfaces.CommentCollectionLoadOptions	表示给定形状的 CommentCollection 对象。
Visio.Interfaces.CommentCollectionUpdateData	用于更新 CommentCollection 对象上的数据的接口，用于 commentCollection.set({ ... }).
Visio.Interfaces.CommentData	一个描述通过调用 comment.toJSON()返回的数据的接口。
Visio.Interfaces.CommentLoadOptions	表示 Comment 对象。
Visio.Interfaces.CommentUpdateData	用于更新 Comment 对象上的数据的接口，用于 comment.set({ ... }).
Visio.Interfaces.DocumentData	一个描述通过调用 document.toJSON()返回的数据的接口。
Visio.Interfaces.DocumentLoadOptions	表示 Document 类。
Visio.Interfaces.DocumentUpdateData	用于更新 Document 对象上的数据的接口，用于 document.set({ ... }).
Visio.Interfaces.DocumentViewData	一个描述通过调用 documentView.toJSON()返回的数据的接口。
Visio.Interfaces.DocumentViewLoadOptions	表示 DocumentView 类。
Visio.Interfaces.DocumentViewUpdateData	用于更新 DocumentView 对象上的数据的接口，用于 documentView.set({ ... }).
Visio.Interfaces.HyperlinkCollectionData	一个描述通过调用 hyperlinkCollection.toJSON()返回的数据的接口。
Visio.Interfaces.HyperlinkCollectionLoadOptions	表示 HyperlinkCollection 对象。
Visio.Interfaces.HyperlinkCollectionUpdateData	用于更新 HyperlinkCollection 对象上的数据的接口，用于 hyperlinkCollection.set({ ... }).
Visio.Interfaces.HyperlinkData	一个描述通过调用 hyperlink.toJSON()返回的数据的接口。
Visio.Interfaces.HyperlinkLoadOptions	表示 Hyperlink 对象。
Visio.Interfaces.PageCollectionData	一个描述通过调用 pageCollection.toJSON()返回的数据的接口。
Visio.Interfaces.PageCollectionLoadOptions	表示属于文档的 Page 对象的集合。
Visio.Interfaces.PageCollectionUpdateData	用于更新 PageCollection 对象上的数据的接口，用于 pageCollection.set({ ... }).
Visio.Interfaces.PageData	一个描述通过调用 page.toJSON()返回的数据的接口。
Visio.Interfaces.PageLoadOptions	表示 Page 类。
Visio.Interfaces.PageUpdateData	用于更新 Page 对象上的数据的接口，用于 page.set({ ... }).
Visio.Interfaces.PageViewData	一个描述通过调用 pageView.toJSON()返回的数据的接口。
Visio.Interfaces.PageViewLoadOptions	表示 PageView 类。
Visio.Interfaces.PageViewUpdateData	用于更新 PageView 对象上的数据的接口，用于 pageView.set({ ... }).
Visio.Interfaces.SelectionData	一个描述通过调用 selection.toJSON()返回的数据的接口。
Visio.Interfaces.ShapeCollectionData	一个描述通过调用 shapeCollection.toJSON()返回的数据的接口。
Visio.Interfaces.ShapeCollectionLoadOptions	表示 Shape 集合。
Visio.Interfaces.ShapeCollectionUpdateData	用于更新 ShapeCollection 对象上的数据的接口，用于 shapeCollection.set({ ... }).
Visio.Interfaces.ShapeData	一个描述通过调用 shape.toJSON()返回的数据的接口。
Visio.Interfaces.ShapeDataItemCollectionData	一个描述通过调用 shapeDataItemCollection.toJSON()返回的数据的接口。
Visio.Interfaces.ShapeDataItemCollectionLoadOptions	表示给定形状的 ShapeDataItemCollection 对象。
Visio.Interfaces.ShapeDataItemCollectionUpdateData	用于更新 ShapeDataItemCollection 对象上的数据的接口，用于 shapeDataItemCollection.set({ ... }).
Visio.Interfaces.ShapeDataItemData	一个描述通过调用 shapeDataItem.toJSON()返回的数据的接口。
Visio.Interfaces.ShapeDataItemLoadOptions	表示 ShapeDataItem 对象。
Visio.Interfaces.ShapeLoadOptions	表示 Shape 类。
Visio.Interfaces.ShapeUpdateData	用于更新 Shape 对象上的数据的接口，用于 shape.set({ ... }).
Visio.Interfaces.ShapeViewData	一个描述通过调用 shapeView.toJSON()返回的数据的接口。
Visio.Interfaces.ShapeViewLoadOptions	表示 ShapeView 类。
Visio.Interfaces.ShapeViewUpdateData	用于更新 ShapeView 对象上的数据的接口，用于 shapeView.set({ ... }).
Visio.PageLoadCompleteEventArgs	提供有关引发了 PageLoadComplete 事件的页面的信息。
Visio.PageRenderCompleteEventArgs	提供有关引发 PageRenderComplete 事件的页面的信息。
Visio.Position	表示对象在视图中的位置。
Visio.SelectionChangedEventArgs	提供有关引发了 SelectionChanged 事件的形状集合的信息。
Visio.ShapeMouseEnterEventArgs	提供有关引发 ShapeMouseEnter 事件的形状的信息。
Visio.ShapeMouseLeaveEventArgs	提供有关引发 ShapeMouseLeave 事件的形状的信息。
Visio.TaskPaneStateChangedEventArgs	提供有关 TaskPaneStateChanged 事件的信息。

枚举

Visio.ColumnType	表示列值的类型。
Visio.ConnectorDirection	DataVisualizer 图表中连接线的方向。
Visio.CrossFunctionalFlowchartOrientation	表示跨职能流程图的方向。
Visio.DataSourceType	表示数据连接的源类型。
Visio.DataValidationErrorType	表示数据验证错误的类型。
Visio.DataVisualizerDiagramOperationType	数据可视化工具图表操作的类型
Visio.DataVisualizerDiagramResultType	数据可视化工具图表操作的结果。
Visio.DataVisualizerDiagramType	数据可视化工具关系图的 DiagramType。
Visio.ErrorCodes
Visio.EventType	EventType 表示主机支持的事件的类型。
Visio.LayoutVariant	表示布局的类型。
Visio.MessageType	MessageType 表示从主机触发事件时的消息类型。
Visio.OverlayHorizontalAlignment	表示叠加相对于形状的水平对齐。
Visio.OverlayType	表示覆盖的类型。
Visio.OverlayVerticalAlignment	表示叠加相对于形状的垂直对齐。
Visio.TaskPaneType	TaskPaneType 表示主机通过 API 支持的第一方任务窗格的类型。 用于显示 TaskPane API、TaskPane 状态已更改或类似事件。
Visio.ToolBarType	应用的工具栏 ID。

函数

Visio.run(batch)	执行批处理脚本，该脚本使用新的请求上下文对 Visio 对象模型执行操作。 解析承诺后，将释放在执行期间自动分配的任何跟踪对象。
Visio.run(object, batch)	执行批处理脚本，该脚本使用以前创建的 API 对象的请求上下文对 Visio 对象模型执行操作。
Visio.run(objects, batch)	执行批处理脚本，该脚本使用以前创建的 API 对象的请求上下文对 Visio 对象模型执行操作。
Visio.run(contextObject, batch)	执行批处理脚本，该脚本使用以前创建的对象的 RequestContext 对 Visio 对象模型执行操作。 解析承诺后，将释放在执行期间自动分配的任何跟踪对象。

函数详细信息

Visio.run(batch)

执行批处理脚本，该脚本使用新的请求上下文对 Visio 对象模型执行操作。 解析承诺后，将释放在执行期间自动分配的任何跟踪对象。

export function run<T>(batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;

参数

batch

(context: Visio.RequestContext) => Promise<T>

一个函数，它采用 Visio.RequestContext 并返回承诺 (通常只是) 的结果 context.sync() 。 context 参数有助于请求 Visio 应用程序。 由于 Office 加载项和 Visio 应用程序在两个不同的进程中运行，因此需要请求上下文才能从加载项访问 Visio 对象模型。

返回

Promise<T>

Visio.run(object, batch)

执行批处理脚本，该脚本使用以前创建的 API 对象的请求上下文对 Visio 对象模型执行操作。

export function run<T>(object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;

参数

object

OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession

以前创建的 API 对象。 批处理将使用与传入对象相同的请求上下文，这意味着应用于对象的任何更改都将由 context.sync().

batch

(context: Visio.RequestContext) => Promise<T>

一个函数，它采用 Visio.RequestContext 并返回承诺 (通常只是) 的结果 context.sync() 。 解析承诺后，将释放在执行期间自动分配的任何跟踪对象。

返回

Promise<T>

示例

// *.run methods automatically create an OfficeExtension.ClientRequestContext
// object to work with the Office file.
Visio.run(session, function (context) {
    const activePage = context.document.getActivePage();
    // Interact with the Visio page... 

    return context.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

Visio.run(objects, batch)

执行批处理脚本，该脚本使用以前创建的 API 对象的请求上下文对 Visio 对象模型执行操作。

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;

参数

objects

OfficeExtension.ClientObject[]

之前创建的 API 对象数组。 将验证数组以确保所有对象共享相同的上下文。 批处理将使用此共享请求上下文，这意味着应用于这些对象的任何更改都将由 context.sync().

batch

(context: Visio.RequestContext) => Promise<T>

一个函数，它采用 Visio.RequestContext 并返回承诺 (通常只是) 的结果 context.sync() 。 解析承诺后，将释放在执行期间自动分配的任何跟踪对象。

返回

Promise<T>

Visio.run(contextObject, batch)

执行批处理脚本，该脚本使用以前创建的对象的 RequestContext 对 Visio 对象模型执行操作。 解析承诺后，将释放在执行期间自动分配的任何跟踪对象。

export function run<T>(contextObject: OfficeExtension.ClientRequestContext, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;

参数

contextObject

OfficeExtension.ClientRequestContext

以前创建的 Visio.RequestContext。 批处理函数 (将重新使用此上下文，而不是) 创建新的上下文。 这意味着批处理将能够选取对现有 API 对象所做的更改（如果这些对象派生自同一上下文）。

batch

(context: Visio.RequestContext) => Promise<T>

一个函数，它接受 RequestContext 并返回承诺 (通常只是) 的结果 context.sync() 。 context 参数有助于请求 Visio 应用程序。 由于 Office 加载项和 Visio 应用程序在两个不同的进程中运行，因此需要 RequestContext 才能从加载项访问 Visio 对象模型。

返回

Promise<T>