visio package

Klassen

Visio.Application	Stellt die Anwendung dar.
Visio.Comment	Stellt den Kommentar dar.
Visio.CommentCollection	Stellt die CommentCollection für ein bestimmtes Shape dar.
Visio.Document	Stellt die Document-Klasse dar.
Visio.DocumentView	Stellt die DocumentView-Klasse dar.
Visio.Hyperlink	Stellt den Hyperlink dar.
Visio.HyperlinkCollection	Stellt die Hyperlinkauflistung dar.
Visio.Page	Stellt die Page-Klasse dar.
Visio.PageCollection	Stellt eine Auflistung von Page-Objekten dar, die Teil des Dokuments sind.
Visio.PageView	Stellt die PageView-Klasse dar.
Visio.RequestContext	Das RequestContext-Objekt erleichtert das Senden von Anforderungen an die Visio-Anwendung. Da das Office-Add-In und die Visio-Anwendung in zwei verschiedenen Prozessen ausgeführt werden, ist der Anforderungskontext erforderlich, um über das Add-In Zugriff auf das Visio-Objektmodell zu erhalten.
Visio.Selection	Stellt die Auswahl auf der Seite dar.
Visio.Shape	Stellt die Shape-Klasse dar.
Visio.ShapeCollection	Stellt die Shape-Auflistung dar.
Visio.ShapeDataItem	Stellt das ShapeDataItem dar.
Visio.ShapeDataItemCollection	Stellt die ShapeDataItemCollection für ein bestimmtes Shape dar.
Visio.ShapeView	Stellt die ShapeView-Klasse dar.

Schnittstellen

Visio.BoundingBox	Stellt die BoundingBox des Shapes dar.
Visio.DataRefreshCompleteEventArgs	Stellt Informationen zu dem Dokument bereit, das das DataRefreshComplete-Ereignis ausgelöst hat.
Visio.DocumentErrorEventArgs	Stellt Informationen zum DocumentError-Ereignis bereit.
Visio.DocumentLoadCompleteEventArgs	Stellt Informationen zum Erfolg oder Fehler des DocumentLoadComplete-Ereignisses bereit.
Visio.Highlight	Stellt die Hervorhebungsdatem dar, die dem Shape hinzugefügt wurden.
Visio.Interfaces.ApplicationData	Eine Schnittstelle, die die durch Aufrufen application.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.ApplicationLoadOptions	Stellt die Anwendung dar.
Visio.Interfaces.ApplicationUpdateData	Eine Schnittstelle zum Aktualisieren von Daten im Application-Objekt zur Verwendung in application.set({ ... }).
Visio.Interfaces.CollectionLoadOptions	Bietet Möglichkeiten zum Laden von Eigenschaften nur einer Teilmenge von Membern einer Auflistung.
Visio.Interfaces.CommentCollectionData	Eine Schnittstelle, die die durch Aufrufen commentCollection.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.CommentCollectionLoadOptions	Stellt die CommentCollection für ein bestimmtes Shape dar.
Visio.Interfaces.CommentCollectionUpdateData	Eine Schnittstelle zum Aktualisieren von Daten im CommentCollection-Objekt zur Verwendung in commentCollection.set({ ... }).
Visio.Interfaces.CommentData	Eine Schnittstelle, die die durch Aufrufen comment.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.CommentLoadOptions	Stellt den Kommentar dar.
Visio.Interfaces.CommentUpdateData	Eine Schnittstelle zum Aktualisieren von Daten für das Comment-Objekt zur Verwendung in comment.set({ ... }).
Visio.Interfaces.DocumentData	Eine Schnittstelle, die die durch Aufrufen document.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.DocumentLoadOptions	Stellt die Document-Klasse dar.
Visio.Interfaces.DocumentUpdateData	Eine Schnittstelle zum Aktualisieren von Daten im Document-Objekt zur Verwendung in document.set({ ... }).
Visio.Interfaces.DocumentViewData	Eine Schnittstelle, die die durch Aufrufen documentView.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.DocumentViewLoadOptions	Stellt die DocumentView-Klasse dar.
Visio.Interfaces.DocumentViewUpdateData	Eine Schnittstelle zum Aktualisieren von Daten im DocumentView-Objekt zur Verwendung in documentView.set({ ... }).
Visio.Interfaces.HyperlinkCollectionData	Eine Schnittstelle, die die durch Aufrufen hyperlinkCollection.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.HyperlinkCollectionLoadOptions	Stellt die Hyperlinkauflistung dar.
Visio.Interfaces.HyperlinkCollectionUpdateData	Eine Schnittstelle zum Aktualisieren von Daten im HyperlinkCollection-Objekt zur Verwendung in hyperlinkCollection.set({ ... }).
Visio.Interfaces.HyperlinkData	Eine Schnittstelle, die die durch Aufrufen hyperlink.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.HyperlinkLoadOptions	Stellt den Hyperlink dar.
Visio.Interfaces.PageCollectionData	Eine Schnittstelle, die die durch Aufrufen pageCollection.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.PageCollectionLoadOptions	Stellt eine Auflistung von Page-Objekten dar, die Teil des Dokuments sind.
Visio.Interfaces.PageCollectionUpdateData	Eine Schnittstelle zum Aktualisieren von Daten im PageCollection-Objekt zur Verwendung in pageCollection.set({ ... }).
Visio.Interfaces.PageData	Eine Schnittstelle, die die durch Aufrufen page.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.PageLoadOptions	Stellt die Page-Klasse dar.
Visio.Interfaces.PageUpdateData	Eine Schnittstelle zum Aktualisieren von Daten im Page-Objekt zur Verwendung in page.set({ ... }).
Visio.Interfaces.PageViewData	Eine Schnittstelle, die die durch Aufrufen pageView.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.PageViewLoadOptions	Stellt die PageView-Klasse dar.
Visio.Interfaces.PageViewUpdateData	Eine Schnittstelle zum Aktualisieren von Daten im PageView-Objekt zur Verwendung in pageView.set({ ... }).
Visio.Interfaces.SelectionData	Eine Schnittstelle, die die durch Aufrufen selection.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.ShapeCollectionData	Eine Schnittstelle, die die durch Aufrufen shapeCollection.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.ShapeCollectionLoadOptions	Stellt die Shape-Auflistung dar.
Visio.Interfaces.ShapeCollectionUpdateData	Eine Schnittstelle zum Aktualisieren von Daten im ShapeCollection-Objekt zur Verwendung in shapeCollection.set({ ... }).
Visio.Interfaces.ShapeData	Eine Schnittstelle, die die durch Aufrufen shape.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.ShapeDataItemCollectionData	Eine Schnittstelle, die die durch Aufrufen shapeDataItemCollection.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.ShapeDataItemCollectionLoadOptions	Stellt die ShapeDataItemCollection für ein bestimmtes Shape dar.
Visio.Interfaces.ShapeDataItemCollectionUpdateData	Eine Schnittstelle zum Aktualisieren von Daten im ShapeDataItemCollection-Objekt zur Verwendung in shapeDataItemCollection.set({ ... }).
Visio.Interfaces.ShapeDataItemData	Eine Schnittstelle, die die durch Aufrufen shapeDataItem.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.ShapeDataItemLoadOptions	Stellt das ShapeDataItem dar.
Visio.Interfaces.ShapeLoadOptions	Stellt die Shape-Klasse dar.
Visio.Interfaces.ShapeUpdateData	Eine Schnittstelle zum Aktualisieren von Daten im Shape-Objekt zur Verwendung in shape.set({ ... }).
Visio.Interfaces.ShapeViewData	Eine Schnittstelle, die die durch Aufrufen shapeView.toJSON()von zurückgegebenen Daten beschreibt.
Visio.Interfaces.ShapeViewLoadOptions	Stellt die ShapeView-Klasse dar.
Visio.Interfaces.ShapeViewUpdateData	Eine Schnittstelle zum Aktualisieren von Daten im ShapeView-Objekt zur Verwendung in shapeView.set({ ... }).
Visio.PageLoadCompleteEventArgs	Stellt Informationen zu der Seite bereit, die das PageLoadComplete-Ereignis ausgelöst hat.
Visio.PageRenderCompleteEventArgs	Stellt Informationen zu der Seite bereit, die das PageRenderComplete-Ereignis ausgelöst hat.
Visio.Position	Stellt die Position des Objekts in der Ansicht dar.
Visio.SelectionChangedEventArgs	Stellt Informationen zu der Shape-Auflistung bereit, die das SelectionChanged-Ereignis ausgelöst hat.
Visio.ShapeMouseEnterEventArgs	Stellt Informationen zu der Form bereit, die das ShapeMouseEnter-Ereignis ausgelöst hat.
Visio.ShapeMouseLeaveEventArgs	Stellt Informationen zu der Form bereit, die das ShapeMouseLeave-Ereignis ausgelöst hat.
Visio.TaskPaneStateChangedEventArgs	Stellt Informationen zum TaskPaneStateChanged-Ereignis bereit.

Enumerationen

Visio.ColumnType	Stellt den Typ der Spaltenwerte dar.
Visio.ConnectorDirection	Richtung des Connectors im DataVisualizer-Diagramm.
Visio.CrossFunctionalFlowchartOrientation	Stellt die Ausrichtung des funktionsübergreifenden Flussdiagramms dar.
Visio.DataSourceType	Stellt den Typ der Quelle für die Datenverbindung dar.
Visio.DataValidationErrorType	Stellt die Typen von Datenüberprüfungsfehlern dar.
Visio.DataVisualizerDiagramOperationType	Typ des Vorgangs "Datenschnellansichtsdiagramm"
Visio.DataVisualizerDiagramResultType	Ergebnis von Vorgängen im Datenschnellansichtsdiagramm.
Visio.DataVisualizerDiagramType	DiagramType für Datenschnellansichtsdiagramme.
Visio.ErrorCodes
Visio.EventType	EventType stellt den Typ der Ereignisse dar, die vom Host unterstützt werden.
Visio.LayoutVariant	Stellt den Typ des Layouts dar.
Visio.MessageType	MessageType stellt den Typ der Nachricht dar, wenn das Ereignis vom Host ausgelöst wird.
Visio.OverlayHorizontalAlignment	Stellt die horizontale Ausrichtung der Überlagerung relativ zur Form dar.
Visio.OverlayType	Stellt den Typ der Überlagerung dar.
Visio.OverlayVerticalAlignment	Stellt die vertikale Ausrichtung der Überlagerung relativ zur Form dar.
Visio.TaskPaneType	TaskPaneType stellt die Typen der Erstanbietertaskpanes dar, die vom Host über APIs unterstützt werden. Wird im Fall von Show TaskPane API, TaskPane State Changed oder ähnlichen Ereignissen verwendet.
Visio.ToolBarType	Symbolleisten-IDs der App.

Functions

Visio.run(batch)	Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell unter Verwendung eines neuen Anforderungskontexts ausführt. Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte, die während der Ausführung automatisch zugeordnet wurden, freigegeben.
Visio.run(object, batch)	Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell unter Verwendung des Anforderungskontexts eines zuvor erstellten API-Objekts ausführt.
Visio.run(objects, batch)	Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell unter Verwendung des Anforderungskontexts der zuvor erstellten API-Objekte ausführt.
Visio.run(contextObject, batch)	Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell unter Verwendung des RequestContext eines zuvor erstellten Objekts ausführt. Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte, die während der Ausführung automatisch zugeordnet wurden, freigegeben.

Details zur Funktion

Visio.run(batch)

Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell unter Verwendung eines neuen Anforderungskontexts ausführt. Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte, die während der Ausführung automatisch zugeordnet wurden, freigegeben.

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

Parameter

batch

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

Eine Funktion, die visio.RequestContext akzeptiert und eine Zusage zurückgibt (in der Regel nur das Ergebnis von "context.sync()"). Der Kontextparameter erleichtert Anforderungen an die Visio-Anwendung. Da das Office-Add-In und die Visio-Anwendung in zwei verschiedenen Prozessen ausgeführt werden, ist der Anforderungskontext erforderlich, um über das Add-In Zugriff auf das Visio-Objektmodell zu erhalten.

Gibt zurück

Promise<T>

Visio.run(object, batch)

Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell unter Verwendung des Anforderungskontexts eines zuvor erstellten API-Objekts ausführt.

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

Parameter

object

OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession

Ein zuvor erstelltes API-Objekt. Der Batch verwendet denselben Anforderungskontext wie das übergebene Objekt, was bedeutet, dass alle auf das Objekt angewendeten Änderungen von "context.sync()" übernommen werden.

batch

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

Eine Funktion, die visio.RequestContext akzeptiert und eine Zusage zurückgibt (in der Regel nur das Ergebnis von "context.sync()"). Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte, die während der Ausführung automatisch zugeordnet wurden, freigegeben.

Gibt zurück

Promise<T>

Visio.run(objects, batch)

Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell unter Verwendung des Anforderungskontexts der zuvor erstellten API-Objekte ausführt.

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

Parameter

objects

OfficeExtension.ClientObject[]

Ein Array von zuvor erstellten API-Objekten. Das Array wird überprüft, um sicherzustellen, dass alle Objekte denselben Kontext verwenden. Der Batch verwendet diesen freigegebenen Anforderungskontext, was bedeutet, dass alle Änderungen, die auf diese Objekte angewendet werden, von "context.sync()" übernommen werden.

batch

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

Eine Funktion, die einen Visio.RequestContext akzeptiert und eine Zusage zurückgibt (in der Regel nur das Ergebnis von "context.sync()"). Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte, die während der Ausführung automatisch zugeordnet wurden, freigegeben.

Gibt zurück

Promise<T>

Visio.run(contextObject, batch)

Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell unter Verwendung des RequestContext eines zuvor erstellten Objekts ausführt. Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte, die während der Ausführung automatisch zugeordnet wurden, freigegeben.

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

Parameter

contextObject

OfficeExtension.ClientRequestContext

Ein zuvor erstelltes Visio.RequestContext-Objekt. Dieser Kontext wird von der Batchfunktion wiederverwendet (anstatt einen neuen Kontext zu erstellen). Dies bedeutet, dass der Batch Änderungen an vorhandenen API-Objekten übernehmen kann, wenn diese Objekte aus diesem Kontext abgeleitet wurden.

batch

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

Eine Funktion, die einen RequestContext akzeptiert und eine Zusage zurückgibt (in der Regel nur das Ergebnis von "context.sync()"). Der Kontextparameter erleichtert Anforderungen an die Visio-Anwendung. Da das Office-Add-In und die Visio-Anwendung in zwei verschiedenen Prozessen ausgeführt werden, ist RequestContext erforderlich, um zugriff auf das Visio-Objektmodell über das Add-In zu erhalten.

Gibt zurück

Promise<T>