visio package

Classes

Visio.Application	Represents the Application.
Visio.Comment	Represents the Comment.
Visio.CommentCollection	Represents the CommentCollection for a given Shape.
Visio.Document	Represents the Document class.
Visio.DocumentView	Represents the DocumentView class.
Visio.Hyperlink	Represents the Hyperlink.
Visio.HyperlinkCollection	Represents the Hyperlink Collection.
Visio.Page	Represents the Page class.
Visio.PageCollection	Represents a collection of Page objects that are part of the document.
Visio.PageView	Represents the PageView class.
Visio.RequestContext	The RequestContext object facilitates requests to the Visio application. Since the Office add-in and the Visio application run in two different processes, the request context is required to get access to the Visio object model from the add-in.
Visio.Selection	Represents the Selection in the page.
Visio.Shape	Represents the Shape class.
Visio.ShapeCollection	Represents the Shape Collection.
Visio.ShapeDataItem	Represents the ShapeDataItem.
Visio.ShapeDataItemCollection	Represents the ShapeDataItemCollection for a given Shape.
Visio.ShapeView	Represents the ShapeView class.

Interfaces

Visio.BoundingBox	Represents the BoundingBox of the shape.
Visio.DataRefreshCompleteEventArgs	Provides information about the document that raised the DataRefreshComplete event.
Visio.DocumentErrorEventArgs	Provides information about DocumentError event.
Visio.DocumentLoadCompleteEventArgs	Provides information about the success or failure of the DocumentLoadComplete event.
Visio.Highlight	Represents the highlight data added to the shape.
Visio.Interfaces.ApplicationData	An interface describing the data returned by calling application.toJSON().
Visio.Interfaces.ApplicationLoadOptions	Represents the Application.
Visio.Interfaces.ApplicationUpdateData	An interface for updating data on the Application object, for use in application.set({ ... }).
Visio.Interfaces.CollectionLoadOptions	Provides ways to load properties of only a subset of members of a collection.
Visio.Interfaces.CommentCollectionData	An interface describing the data returned by calling commentCollection.toJSON().
Visio.Interfaces.CommentCollectionLoadOptions	Represents the CommentCollection for a given Shape.
Visio.Interfaces.CommentCollectionUpdateData	An interface for updating data on the CommentCollection object, for use in commentCollection.set({ ... }).
Visio.Interfaces.CommentData	An interface describing the data returned by calling comment.toJSON().
Visio.Interfaces.CommentLoadOptions	Represents the Comment.
Visio.Interfaces.CommentUpdateData	An interface for updating data on the Comment object, for use in comment.set({ ... }).
Visio.Interfaces.DocumentData	An interface describing the data returned by calling document.toJSON().
Visio.Interfaces.DocumentLoadOptions	Represents the Document class.
Visio.Interfaces.DocumentUpdateData	An interface for updating data on the Document object, for use in document.set({ ... }).
Visio.Interfaces.DocumentViewData	An interface describing the data returned by calling documentView.toJSON().
Visio.Interfaces.DocumentViewLoadOptions	Represents the DocumentView class.
Visio.Interfaces.DocumentViewUpdateData	An interface for updating data on the DocumentView object, for use in documentView.set({ ... }).
Visio.Interfaces.HyperlinkCollectionData	An interface describing the data returned by calling hyperlinkCollection.toJSON().
Visio.Interfaces.HyperlinkCollectionLoadOptions	Represents the Hyperlink Collection.
Visio.Interfaces.HyperlinkCollectionUpdateData	An interface for updating data on the HyperlinkCollection object, for use in hyperlinkCollection.set({ ... }).
Visio.Interfaces.HyperlinkData	An interface describing the data returned by calling hyperlink.toJSON().
Visio.Interfaces.HyperlinkLoadOptions	Represents the Hyperlink.
Visio.Interfaces.PageCollectionData	An interface describing the data returned by calling pageCollection.toJSON().
Visio.Interfaces.PageCollectionLoadOptions	Represents a collection of Page objects that are part of the document.
Visio.Interfaces.PageCollectionUpdateData	An interface for updating data on the PageCollection object, for use in pageCollection.set({ ... }).
Visio.Interfaces.PageData	An interface describing the data returned by calling page.toJSON().
Visio.Interfaces.PageLoadOptions	Represents the Page class.
Visio.Interfaces.PageUpdateData	An interface for updating data on the Page object, for use in page.set({ ... }).
Visio.Interfaces.PageViewData	An interface describing the data returned by calling pageView.toJSON().
Visio.Interfaces.PageViewLoadOptions	Represents the PageView class.
Visio.Interfaces.PageViewUpdateData	An interface for updating data on the PageView object, for use in pageView.set({ ... }).
Visio.Interfaces.SelectionData	An interface describing the data returned by calling selection.toJSON().
Visio.Interfaces.ShapeCollectionData	An interface describing the data returned by calling shapeCollection.toJSON().
Visio.Interfaces.ShapeCollectionLoadOptions	Represents the Shape Collection.
Visio.Interfaces.ShapeCollectionUpdateData	An interface for updating data on the ShapeCollection object, for use in shapeCollection.set({ ... }).
Visio.Interfaces.ShapeData	An interface describing the data returned by calling shape.toJSON().
Visio.Interfaces.ShapeDataItemCollectionData	An interface describing the data returned by calling shapeDataItemCollection.toJSON().
Visio.Interfaces.ShapeDataItemCollectionLoadOptions	Represents the ShapeDataItemCollection for a given Shape.
Visio.Interfaces.ShapeDataItemCollectionUpdateData	An interface for updating data on the ShapeDataItemCollection object, for use in shapeDataItemCollection.set({ ... }).
Visio.Interfaces.ShapeDataItemData	An interface describing the data returned by calling shapeDataItem.toJSON().
Visio.Interfaces.ShapeDataItemLoadOptions	Represents the ShapeDataItem.
Visio.Interfaces.ShapeLoadOptions	Represents the Shape class.
Visio.Interfaces.ShapeUpdateData	An interface for updating data on the Shape object, for use in shape.set({ ... }).
Visio.Interfaces.ShapeViewData	An interface describing the data returned by calling shapeView.toJSON().
Visio.Interfaces.ShapeViewLoadOptions	Represents the ShapeView class.
Visio.Interfaces.ShapeViewUpdateData	An interface for updating data on the ShapeView object, for use in shapeView.set({ ... }).
Visio.PageLoadCompleteEventArgs	Provides information about the page that raised the PageLoadComplete event.
Visio.PageRenderCompleteEventArgs	Provides information about the page that raised the PageRenderComplete event.
Visio.Position	Represents the Position of the object in the view.
Visio.SelectionChangedEventArgs	Provides information about the shape collection that raised the SelectionChanged event.
Visio.ShapeMouseEnterEventArgs	Provides information about the shape that raised the ShapeMouseEnter event.
Visio.ShapeMouseLeaveEventArgs	Provides information about the shape that raised the ShapeMouseLeave event.
Visio.TaskPaneStateChangedEventArgs	Provides information about the TaskPaneStateChanged event.

Enums

Visio.ColumnType	Represents the type of column values.
Visio.ConnectorDirection	Direction of connector in DataVisualizer diagram.
Visio.CrossFunctionalFlowchartOrientation	Represents the orientation of the Cross Functional Flowchart diagram.
Visio.DataSourceType	Represents the type of source for the data connection.
Visio.DataValidationErrorType	Represents the types of data validation error.
Visio.DataVisualizerDiagramOperationType	Type of the Data Visualizer Diagram operation
Visio.DataVisualizerDiagramResultType	Result of Data Visualizer Diagram operations.
Visio.DataVisualizerDiagramType	DiagramType for Data Visualizer diagrams.
Visio.ErrorCodes
Visio.EventType	EventType represents the type of the events Host supports.
Visio.LayoutVariant	Represents the type of layout.
Visio.MessageType	MessageType represents the type of message when event is fired from Host.
Visio.OverlayHorizontalAlignment	Represents the Horizontal Alignment of the Overlay relative to the shape.
Visio.OverlayType	Represents the type of the overlay.
Visio.OverlayVerticalAlignment	Represents the Vertical Alignment of the Overlay relative to the shape.
Visio.TaskPaneType	TaskPaneType represents the types of the First Party TaskPanes that are supported by Host through APIs. Used in case of Show TaskPane API, TaskPane State Changed, or similar events.
Visio.ToolBarType	Toolbar IDs of the app.

Functions

Visio.run(batch)	Executes a batch script that performs actions on the Visio object model, using a new request context. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
Visio.run(object, batch)	Executes a batch script that performs actions on the Visio object model, using the request context of a previously-created API object.
Visio.run(objects, batch)	Executes a batch script that performs actions on the Visio object model, using the request context of previously-created API objects.
Visio.run(contextObject, batch)	Executes a batch script that performs actions on the Visio object model, using the RequestContext of a previously-created object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

Function Details

Visio.run(batch)

Executes a batch script that performs actions on the Visio object model, using a new request context. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

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

Parameters

batch

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

A function that takes in an Visio.RequestContext and returns a promise (typically, just the result of context.sync()). The context parameter facilitates requests to the Visio application. Since the Office add-in and the Visio application run in two different processes, the request context is required to get access to the Visio object model from the add-in.

Returns

Promise<T>

Visio.run(object, batch)

Executes a batch script that performs actions on the Visio object model, using the request context of a previously-created API object.

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

Parameters

object

OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession

A previously-created API object. The batch will use the same request context as the passed-in object, which means that any changes applied to the object will be picked up by context.sync().

batch

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

A function that takes in an Visio.RequestContext and returns a promise (typically, just the result of context.sync()). When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

Returns

Promise<T>

Visio.run(objects, batch)

Executes a batch script that performs actions on the Visio object model, using the request context of previously-created API objects.

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

Parameters

objects

OfficeExtension.ClientObject[]

An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared request context, which means that any changes applied to these objects will be picked up by context.sync().

batch

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

A function that takes in a Visio.RequestContext and returns a promise (typically, just the result of context.sync()). When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

Returns

Promise<T>

Visio.run(contextObject, batch)

Executes a batch script that performs actions on the Visio object model, using the RequestContext of a previously-created object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

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

Parameters

contextObject

OfficeExtension.ClientRequestContext

A previously-created Visio.RequestContext. This context will get re-used by the batch function (instead of having a new context created). This means that the batch will be able to pick up changes made to existing API objects, if those objects were derived from this same context.

batch

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

A function that takes in a RequestContext and returns a promise (typically, just the result of context.sync()). The context parameter facilitates requests to the Visio application. Since the Office add-in and the Visio application run in two different processes, the RequestContext is required to get access to the Visio object model from the add-in.

Returns

Promise<T>