visio package

Classes

Visio.Application	Représente l’objet Application.
Visio.Comment	Représente le commentaire.
Visio.CommentCollection	Représente la collection de commentaires d’une forme donnée.
Visio.Document	Représente la classe Document.
Visio.DocumentView	Représente la classe DocumentView.
Visio.Hyperlink	Représente l’objet Hyperlink.
Visio.HyperlinkCollection	Représente l’objet HyperlinkCollection.
Visio.Page	Représente la classe Page.
Visio.PageCollection	Représente une collection d’objets Page faisant partie du document.
Visio.PageView	Représente la classe PageView.
Visio.RequestContext	L’objet RequestContext facilite les demandes auprès de l’application Visio. Étant donné que le complément Office et l’application Visio s’exécutent dans deux processus différents, le contexte de demande est nécessaire pour accéder au modèle objet Visio à partir du complément.
Visio.Selection	Représente la sélection dans la page.
Visio.Shape	Représente la classe Shape.
Visio.ShapeCollection	Représente la collection Shape.
Visio.ShapeDataItem	Représente l’objet ShapeDataItem.
Visio.ShapeDataItemCollection	Représente la collection d’éléments de données pour une forme donnée.
Visio.ShapeView	Représente la classe ShapeView.

Interfaces

Visio.BoundingBox	Représente le BoundingBox de la forme.
Visio.DataRefreshCompleteEventArgs	Fournit des informations sur le document qui a déclenché l’événement DataRefreshComplete.
Visio.DocumentErrorEventArgs	Fournit des informations sur l’événement DocumentError.
Visio.DocumentLoadCompleteEventArgs	Fournit des informations sur la réussite ou l’échec de l’événement DocumentLoadComplete.
Visio.Highlight	Représente les données mises en surbrillance ajoutées à la forme.
Visio.Interfaces.ApplicationData	Interface décrivant les données retournées en appelant application.toJSON().
Visio.Interfaces.ApplicationLoadOptions	Représente l’objet Application.
Visio.Interfaces.ApplicationUpdateData	Interface pour la mise à jour des données sur l’objet Application, à utiliser dans application.set({ ... }).
Visio.Interfaces.CollectionLoadOptions	Fournit des moyens de charger les propriétés d’un sous-ensemble de membres d’une collection uniquement.
Visio.Interfaces.CommentCollectionData	Interface décrivant les données retournées en appelant commentCollection.toJSON().
Visio.Interfaces.CommentCollectionLoadOptions	Représente la collection de commentaires d’une forme donnée.
Visio.Interfaces.CommentCollectionUpdateData	Interface pour la mise à jour des données sur l’objet CommentCollection, à utiliser dans commentCollection.set({ ... }).
Visio.Interfaces.CommentData	Interface décrivant les données retournées en appelant comment.toJSON().
Visio.Interfaces.CommentLoadOptions	Représente le commentaire.
Visio.Interfaces.CommentUpdateData	Interface permettant de mettre à jour les données sur l’objet Comment, à utiliser dans comment.set({ ... }).
Visio.Interfaces.DocumentData	Interface décrivant les données retournées en appelant document.toJSON().
Visio.Interfaces.DocumentLoadOptions	Représente la classe Document.
Visio.Interfaces.DocumentUpdateData	Interface pour la mise à jour des données sur l’objet Document, à utiliser dans document.set({ ... }).
Visio.Interfaces.DocumentViewData	Interface décrivant les données retournées en appelant documentView.toJSON().
Visio.Interfaces.DocumentViewLoadOptions	Représente la classe DocumentView.
Visio.Interfaces.DocumentViewUpdateData	Interface pour la mise à jour des données sur l’objet DocumentView, à utiliser dans documentView.set({ ... }).
Visio.Interfaces.HyperlinkCollectionData	Interface décrivant les données retournées en appelant hyperlinkCollection.toJSON().
Visio.Interfaces.HyperlinkCollectionLoadOptions	Représente l’objet HyperlinkCollection.
Visio.Interfaces.HyperlinkCollectionUpdateData	Interface permettant de mettre à jour les données sur l’objet HyperlinkCollection, à utiliser dans hyperlinkCollection.set({ ... }).
Visio.Interfaces.HyperlinkData	Interface décrivant les données retournées en appelant hyperlink.toJSON().
Visio.Interfaces.HyperlinkLoadOptions	Représente l’objet Hyperlink.
Visio.Interfaces.PageCollectionData	Interface décrivant les données retournées en appelant pageCollection.toJSON().
Visio.Interfaces.PageCollectionLoadOptions	Représente une collection d’objets Page faisant partie du document.
Visio.Interfaces.PageCollectionUpdateData	Interface pour la mise à jour des données sur l’objet PageCollection, à utiliser dans pageCollection.set({ ... }).
Visio.Interfaces.PageData	Interface décrivant les données retournées en appelant page.toJSON().
Visio.Interfaces.PageLoadOptions	Représente la classe Page.
Visio.Interfaces.PageUpdateData	Interface pour la mise à jour des données sur l’objet Page, à utiliser dans page.set({ ... }).
Visio.Interfaces.PageViewData	Interface décrivant les données retournées en appelant pageView.toJSON().
Visio.Interfaces.PageViewLoadOptions	Représente la classe PageView.
Visio.Interfaces.PageViewUpdateData	Interface pour la mise à jour des données sur l’objet PageView, à utiliser dans pageView.set({ ... }).
Visio.Interfaces.SelectionData	Interface décrivant les données retournées en appelant selection.toJSON().
Visio.Interfaces.ShapeCollectionData	Interface décrivant les données retournées en appelant shapeCollection.toJSON().
Visio.Interfaces.ShapeCollectionLoadOptions	Représente la collection Shape.
Visio.Interfaces.ShapeCollectionUpdateData	Interface pour la mise à jour des données sur l’objet ShapeCollection, à utiliser dans shapeCollection.set({ ... }).
Visio.Interfaces.ShapeData	Interface décrivant les données retournées en appelant shape.toJSON().
Visio.Interfaces.ShapeDataItemCollectionData	Interface décrivant les données retournées en appelant shapeDataItemCollection.toJSON().
Visio.Interfaces.ShapeDataItemCollectionLoadOptions	Représente la collection d’éléments de données pour une forme donnée.
Visio.Interfaces.ShapeDataItemCollectionUpdateData	Interface permettant de mettre à jour les données sur l’objet ShapeDataItemCollection, à utiliser dans shapeDataItemCollection.set({ ... }).
Visio.Interfaces.ShapeDataItemData	Interface décrivant les données retournées en appelant shapeDataItem.toJSON().
Visio.Interfaces.ShapeDataItemLoadOptions	Représente l’objet ShapeDataItem.
Visio.Interfaces.ShapeLoadOptions	Représente la classe Shape.
Visio.Interfaces.ShapeUpdateData	Interface pour la mise à jour des données sur l’objet Shape, à utiliser dans shape.set({ ... }).
Visio.Interfaces.ShapeViewData	Interface décrivant les données retournées en appelant shapeView.toJSON().
Visio.Interfaces.ShapeViewLoadOptions	Représente la classe ShapeView.
Visio.Interfaces.ShapeViewUpdateData	Interface pour la mise à jour des données sur l’objet ShapeView, à utiliser dans shapeView.set({ ... }).
Visio.PageLoadCompleteEventArgs	Fournit des informations sur la page qui a déclenché l’événement PageLoadComplete.
Visio.PageRenderCompleteEventArgs	Fournit des informations sur la page qui a déclenché l’événement PageRenderComplete.
Visio.Position	Représente la position de l’objet dans l’affichage.
Visio.SelectionChangedEventArgs	Fournit des informations sur la collection de formes qui a déclenché l’événement SelectionChanged.
Visio.ShapeMouseEnterEventArgs	Fournit des informations sur la forme qui a déclenché l’événement ShapeMouseEnter.
Visio.ShapeMouseLeaveEventArgs	Fournit des informations sur la forme qui a déclenché l’événement ShapeMouseLeave.
Visio.TaskPaneStateChangedEventArgs	Fournit des informations sur l’événement TaskPaneStateChanged.

Énumérations

Visio.ColumnType	Représente le type de valeurs de colonne.
Visio.ConnectorDirection	Direction du connecteur dans le diagramme DataVisualizer.
Visio.CrossFunctionalFlowchartOrientation	Représente l’orientation du diagramme d’organigramme fonctionnel croisé.
Visio.DataSourceType	Représente le type de source pour la connexion de données.
Visio.DataValidationErrorType	Représente les types d’erreur de validation des données.
Visio.DataVisualizerDiagramOperationType	Type de l’opération de diagramme du visualiseur de données
Visio.DataVisualizerDiagramResultType	Résultat des opérations de diagramme du visualiseur de données.
Visio.DataVisualizerDiagramType	DiagramType pour les diagrammes du visualiseur de données.
Visio.ErrorCodes
Visio.EventType	EventType représente le type des événements pris en charge par l’hôte.
Visio.LayoutVariant	Représente le type de disposition.
Visio.MessageType	MessageType représente le type de message lorsque l’événement est déclenché à partir de l’hôte.
Visio.OverlayHorizontalAlignment	Représente l’alignement horizontal de la superposition par rapport à la forme.
Visio.OverlayType	Représente le type de la superposition.
Visio.OverlayVerticalAlignment	Représente l’alignement vertical de la superposition par rapport à la forme.
Visio.TaskPaneType	TaskPaneType représente les types des TaskPanes internes pris en charge par Host via des API. Utilisé dans le cas de l’API Show TaskPane, de taskPane State Changed ou d’événements similaires.
Visio.ToolBarType	ID de barre d’outils de l’application.

Functions

Visio.run(batch)	Exécute un script de traitement par lots qui effectue des actions sur le modèle objet Visio, à l’aide d’un nouveau contexte de requête. Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.
Visio.run(object, batch)	Exécute un script de traitement par lots qui effectue des actions sur le modèle objet Visio, à l’aide du contexte de requête d’un objet API créé précédemment.
Visio.run(objects, batch)	Exécute un script de traitement par lots qui effectue des actions sur le modèle objet Visio, à l’aide du contexte de requête des objets API créés précédemment.
Visio.run(contextObject, batch)	Exécute un script de traitement par lots qui effectue des actions sur le modèle objet Visio, à l’aide du RequestContext d’un objet créé précédemment. Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

Informations relatives à la fonction

Visio.run(batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet Visio, à l’aide d’un nouveau contexte de requête. Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

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

Paramètres

batch

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

Fonction qui accepte un Visio.RequestContext et retourne une promesse (en général, uniquement le résultat de context.sync()). Le paramètre de contexte facilite les requêtes adressées à l’application Visio. Étant donné que le complément Office et l’application Visio s’exécutent dans deux processus différents, le contexte de demande est nécessaire pour accéder au modèle objet Visio à partir du complément.

Retours

Promise<T>

Visio.run(object, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet Visio, à l’aide du contexte de requête d’un objet API créé précédemment.

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

Paramètres

object

OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession

Objet API créé précédemment. Le lot utilise le même contexte de requête que l’objet passé, ce qui signifie que toutes les modifications appliquées à l’objet seront récupérées par context.sync().

batch

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

Fonction qui accepte un Visio.RequestContext et retourne une promesse (en général, uniquement le résultat de context.sync()). Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

Retours

Promise<T>

Visio.run(objects, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet Visio, à l’aide du contexte de requête des objets API créés précédemment.

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

Paramètres

objects

OfficeExtension.ClientObject[]

Tableau d’objets API créés précédemment. Le tableau est validé pour s’assurer que tous les objets partagent le même contexte. Le lot utilise ce contexte de demande partagée, ce qui signifie que toutes les modifications appliquées à ces objets seront récupérées par context.sync().

batch

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

Fonction qui accepte un Visio.RequestContext et retourne une promesse (en général, uniquement le résultat de context.sync()). Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

Retours

Promise<T>

Visio.run(contextObject, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet Visio, à l’aide du RequestContext d’un objet créé précédemment. Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

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

Paramètres

contextObject

OfficeExtension.ClientRequestContext

Visio.RequestContext créé précédemment. Ce contexte est réutilisé par la fonction batch (au lieu d’avoir un nouveau contexte créé). Cela signifie que le lot sera en mesure de récupérer les modifications apportées aux objets API existants, si ces objets ont été dérivés de ce même contexte.

batch

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

Fonction qui accepte un RequestContext et retourne une promesse (en général, juste le résultat de context.sync()). Le paramètre de contexte facilite les requêtes adressées à l’application Visio. Étant donné que le complément Office et l’application Visio s’exécutent dans deux processus différents, requestContext est requis pour accéder au modèle objet Visio à partir du complément.

Retours

Promise<T>