visio package
Clases
Visio.Application |
Representa la aplicación. |
Visio.Comment |
Representa el comentario. |
Visio.CommentCollection |
Representa el elemento CommentCollection de una forma determinada. |
Visio.Document |
Representa la clase Document. |
Visio.DocumentView |
Representa la clase DocumentView. |
Visio.Hyperlink |
Representa el hipervínculo. |
Visio.HyperlinkCollection |
Representa la colección de hipervínculos. |
Visio.Page |
Representa la clase Page. |
Visio.PageCollection |
Representa una colección de objetos Page que forman parte del documento. |
Visio.PageView |
Representa la clase PageView. |
Visio.RequestContext |
El objeto RequestContext facilita las solicitudes para la aplicación de Visio. Dado que el complemento de Office y la aplicación de Visio se ejecutan en dos procesos diferentes, el contexto de solicitud es necesario para obtener acceso al modelo de objetos de Visio desde el complemento. |
Visio.Selection |
Representa la selección de la página. |
Visio.Shape |
Representa la clase Shape. |
Visio.ShapeCollection |
Representa la colección de formas. |
Visio.ShapeDataItem |
Representa el elemento ShapeDataItem. |
Visio.ShapeDataItemCollection |
Representa la clase ShapeDataItemCollection de una forma determinada. |
Visio.ShapeView |
Representa la clase ShapeView. |
Interfaces
Visio.BoundingBox |
Representa el cuadro de límite de la forma. |
Visio.DataRefreshCompleteEventArgs |
Proporciona información sobre el documento que ha generado el evento DataRefreshComplete. |
Visio.DocumentErrorEventArgs |
Proporciona información sobre el evento DocumentError. |
Visio.DocumentLoadCompleteEventArgs |
Proporciona información sobre el éxito o error del evento DocumentLoadComplete. |
Visio.Highlight |
Representa los datos resaltados añadidos a la forma. |
Visio.Interfaces.ApplicationData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.ApplicationLoadOptions |
Representa la aplicación. |
Visio.Interfaces.ApplicationUpdateData |
Interfaz para actualizar datos en el objeto Application, para su uso en |
Visio.Interfaces.CollectionLoadOptions |
Proporciona formas de cargar las propiedades de solo un subconjunto de miembros de una colección. |
Visio.Interfaces.CommentCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.CommentCollectionLoadOptions |
Representa el elemento CommentCollection de una forma determinada. |
Visio.Interfaces.CommentCollectionUpdateData |
Interfaz para actualizar datos en el objeto CommentCollection, para su uso en |
Visio.Interfaces.CommentData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.CommentLoadOptions |
Representa el comentario. |
Visio.Interfaces.CommentUpdateData |
Interfaz para actualizar datos en el objeto Comment, para su uso en |
Visio.Interfaces.DocumentData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.DocumentLoadOptions |
Representa la clase Document. |
Visio.Interfaces.DocumentUpdateData |
Interfaz para actualizar datos en el objeto Document, para su uso en |
Visio.Interfaces.DocumentViewData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.DocumentViewLoadOptions |
Representa la clase DocumentView. |
Visio.Interfaces.DocumentViewUpdateData |
Interfaz para actualizar datos en el objeto DocumentView, para su uso en |
Visio.Interfaces.HyperlinkCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.HyperlinkCollectionLoadOptions |
Representa la colección de hipervínculos. |
Visio.Interfaces.HyperlinkCollectionUpdateData |
Interfaz para actualizar datos en el objeto HyperlinkCollection, para su uso en |
Visio.Interfaces.HyperlinkData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.HyperlinkLoadOptions |
Representa el hipervínculo. |
Visio.Interfaces.PageCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.PageCollectionLoadOptions |
Representa una colección de objetos Page que forman parte del documento. |
Visio.Interfaces.PageCollectionUpdateData |
Interfaz para actualizar datos en el objeto PageCollection, para su uso en |
Visio.Interfaces.PageData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.PageLoadOptions |
Representa la clase Page. |
Visio.Interfaces.PageUpdateData |
Interfaz para actualizar datos en el objeto Page, para su uso en |
Visio.Interfaces.PageViewData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.PageViewLoadOptions |
Representa la clase PageView. |
Visio.Interfaces.PageViewUpdateData |
Interfaz para actualizar datos en el objeto PageView, para su uso en |
Visio.Interfaces.SelectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.ShapeCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.ShapeCollectionLoadOptions |
Representa la colección de formas. |
Visio.Interfaces.ShapeCollectionUpdateData |
Interfaz para actualizar datos en el objeto ShapeCollection, para su uso en |
Visio.Interfaces.ShapeData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.ShapeDataItemCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.ShapeDataItemCollectionLoadOptions |
Representa la clase ShapeDataItemCollection de una forma determinada. |
Visio.Interfaces.ShapeDataItemCollectionUpdateData |
Interfaz para actualizar datos en el objeto ShapeDataItemCollection, para su uso en |
Visio.Interfaces.ShapeDataItemData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.ShapeDataItemLoadOptions |
Representa el elemento ShapeDataItem. |
Visio.Interfaces.ShapeLoadOptions |
Representa la clase Shape. |
Visio.Interfaces.ShapeUpdateData |
Interfaz para actualizar datos en el objeto Shape, para su uso en |
Visio.Interfaces.ShapeViewData |
Interfaz que describe los datos devueltos mediante una llamada a |
Visio.Interfaces.ShapeViewLoadOptions |
Representa la clase ShapeView. |
Visio.Interfaces.ShapeViewUpdateData |
Interfaz para actualizar datos en el objeto ShapeView, para su uso en |
Visio.PageLoadCompleteEventArgs |
Proporciona información sobre la página que ha generado el evento PageLoadComplete. |
Visio.PageRenderCompleteEventArgs |
Proporciona información sobre la página que generó el evento PageRenderComplete. |
Visio.Position |
Representa la posición del objeto en la vista. |
Visio.SelectionChangedEventArgs |
Proporciona información sobre la colección de formas que ha generado el evento SelectionChanged. |
Visio.ShapeMouseEnterEventArgs |
Proporciona información sobre la forma que generó el evento ShapeMouseEnter. |
Visio.ShapeMouseLeaveEventArgs |
Proporciona información sobre la forma que generó el evento ShapeMouseLeave. |
Visio.TaskPaneStateChangedEventArgs |
Proporciona información sobre el evento TaskPaneStateChanged. |
Enumeraciones
Visio.ColumnType |
Representa el tipo de valores de columna. |
Visio.ConnectorDirection |
Dirección del conector en el diagrama de DataVisualizer. |
Visio.CrossFunctionalFlowchartOrientation |
Representa la orientación del diagrama de diagrama de flujo funcional cruzado. |
Visio.DataSourceType |
Representa el tipo de origen de la conexión de datos. |
Visio.DataValidationErrorType |
Representa los tipos de error de validación de datos. |
Visio.DataVisualizerDiagramOperationType |
Tipo de la operación Diagrama del visualizador de datos |
Visio.DataVisualizerDiagramResultType |
Resultado de las operaciones del diagrama del visualizador de datos. |
Visio.DataVisualizerDiagramType |
DiagramType para diagramas del Visualizador de datos. |
Visio.ErrorCodes | |
Visio.EventType |
EventType representa el tipo de eventos que admite host. |
Visio.LayoutVariant |
Representa el tipo de diseño. |
Visio.MessageType |
MessageType representa el tipo de mensaje cuando se desencadena el evento desde host. |
Visio.OverlayHorizontalAlignment |
Representa la alineación horizontal de la superposición con respecto a la forma. |
Visio.OverlayType |
Representa el tipo de la superposición. |
Visio.OverlayVerticalAlignment |
Representa la alineación vertical de la superposición con respecto a la forma. |
Visio.TaskPaneType |
TaskPaneType representa los tipos de los paneles de tareas de primera entidad admitidos por host a través de las API. Se usa en el caso de Show TaskPane API, TaskPane State Changed o eventos similares. |
Visio.ToolBarType |
Identificadores de barra de herramientas de la aplicación. |
Funciones
Visio. |
Ejecuta un script por lotes que realiza acciones en el modelo de objetos de Visio mediante un nuevo contexto de solicitud. Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución. |
Visio. |
Ejecuta un script por lotes que realiza acciones en el modelo de objetos de Visio mediante el contexto de solicitud de un objeto de API creado anteriormente. |
Visio. |
Ejecuta un script por lotes que realiza acciones en el modelo de objetos de Visio mediante el contexto de solicitud de objetos de API creados anteriormente. |
Visio. |
Ejecuta un script por lotes que realiza acciones en el modelo de objetos de Visio mediante requestContext de un objeto creado anteriormente. Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución. |
Detalles de la función
Visio.run(batch)
Ejecuta un script por lotes que realiza acciones en el modelo de objetos de Visio mediante un nuevo contexto de solicitud. Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.
export function run<T>(batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
Parámetros
- batch
-
(context: Visio.RequestContext) => Promise<T>
Función que toma visio.RequestContext y devuelve una promesa (normalmente, solo el resultado de context.sync()
). El parámetro de contexto facilita las solicitudes a la aplicación de Visio. Dado que el complemento de Office y la aplicación de Visio se ejecutan en dos procesos diferentes, el contexto de solicitud es necesario para obtener acceso al modelo de objetos de Visio desde el complemento.
Devoluciones
Promise<T>
Visio.run(object, batch)
Ejecuta un script por lotes que realiza acciones en el modelo de objetos de Visio mediante el contexto de solicitud de un objeto de API creado anteriormente.
export function run<T>(object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
Parámetros
Objeto de API creado anteriormente. El lote usará el mismo contexto de solicitud que el objeto pasado, lo que significa que cualquier cambio aplicado al objeto será recogido por context.sync()
.
- batch
-
(context: Visio.RequestContext) => Promise<T>
Función que toma visio.RequestContext y devuelve una promesa (normalmente, solo el resultado de context.sync()
). Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.
Devoluciones
Promise<T>
Visio.run(objects, batch)
Ejecuta un script por lotes que realiza acciones en el modelo de objetos de Visio mediante el contexto de solicitud de objetos de API creados anteriormente.
export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
Parámetros
- objects
Matriz de objetos de API creados anteriormente. La matriz se validará para asegurarse de que todos los objetos comparten el mismo contexto. El lote usará este contexto de solicitud compartida, lo que significa que cualquier cambio aplicado a estos objetos será recogido por context.sync()
.
- batch
-
(context: Visio.RequestContext) => Promise<T>
Función que toma visio.RequestContext y devuelve una promesa (normalmente, solo el resultado de context.sync()
). Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.
Devoluciones
Promise<T>
Visio.run(contextObject, batch)
Ejecuta un script por lotes que realiza acciones en el modelo de objetos de Visio mediante requestContext de un objeto creado anteriormente. Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.
export function run<T>(contextObject: OfficeExtension.ClientRequestContext, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
Parámetros
- contextObject
- OfficeExtension.ClientRequestContext
Visio.RequestContext creado anteriormente. La función por lotes volverá a usar este contexto (en lugar de crear un nuevo contexto). Esto significa que el lote podrá recoger los cambios realizados en los objetos de API existentes, si esos objetos se derivan de este mismo contexto.
- batch
-
(context: Visio.RequestContext) => Promise<T>
Función que toma un RequestContext y devuelve una promesa (normalmente, solo el resultado de context.sync()
). El parámetro de contexto facilita las solicitudes a la aplicación de Visio. Dado que el complemento de Office y la aplicación de Visio se ejecutan en dos procesos diferentes, RequestContext es necesario para obtener acceso al modelo de objetos de Visio desde el complemento.
Devoluciones
Promise<T>