visio package

Classes

Visio.Application	Representa o Aplicativo.
Visio.Comment	Representa o Comentário.
Visio.CommentCollection	Representa o CommentCollection para determinada Forma.
Visio.Document	Representa a classe Document.
Visio.DocumentView	Representa a classe DocumentView.
Visio.Hyperlink	Representa o Hiperlink.
Visio.HyperlinkCollection	Representa a Coleção de Hiperlinks.
Visio.Page	Representa a classe Page.
Visio.PageCollection	Representa uma coleção de todos os objetos da Página que fazem parte do documento.
Visio.PageView	Representa a classe PageView.
Visio.RequestContext	O objeto RequestContext facilita as solicitações para o aplicativo do Visio. Como o suplemento do Office e o aplicativo Visio são executados em dois processos diferentes, o contexto de solicitação é necessário para obter acesso ao modelo de objeto visio do suplemento.
Visio.Selection	Representa a Seleção na página.
Visio.Shape	Representa a classe Shape.
Visio.ShapeCollection	Representa a Coleção de Formas.
Visio.ShapeDataItem	Representa o ShapeDataItem.
Visio.ShapeDataItemCollection	Representa o ShapeDataItemCollection de uma determinada Forma.
Visio.ShapeView	Representa a classe ShapeView.

Interfaces

Visio.BoundingBox	Representa BoundingBox da forma.
Visio.DataRefreshCompleteEventArgs	Fornece informações sobre o documento que gerou o evento DataRefreshComplete.
Visio.DocumentErrorEventArgs	Fornece informações sobre o evento DocumentError.
Visio.DocumentLoadCompleteEventArgs	Fornece informações sobre o sucesso ou falha do evento DocumentLoadComplete.
Visio.Highlight	Representa os dados de realce adicionados à forma.
Visio.Interfaces.ApplicationData	Uma interface que descreve os dados retornados chamando application.toJSON().
Visio.Interfaces.ApplicationLoadOptions	Representa o Aplicativo.
Visio.Interfaces.ApplicationUpdateData	Uma interface para atualizar dados no objeto Application, para uso em application.set({ ... }).
Visio.Interfaces.CollectionLoadOptions	Fornece maneiras de carregar propriedades de apenas um subconjunto de membros de uma coleção.
Visio.Interfaces.CommentCollectionData	Uma interface que descreve os dados retornados chamando commentCollection.toJSON().
Visio.Interfaces.CommentCollectionLoadOptions	Representa o CommentCollection para determinada Forma.
Visio.Interfaces.CommentCollectionUpdateData	Uma interface para atualizar dados no objeto CommentCollection, para uso em commentCollection.set({ ... }).
Visio.Interfaces.CommentData	Uma interface que descreve os dados retornados chamando comment.toJSON().
Visio.Interfaces.CommentLoadOptions	Representa o Comentário.
Visio.Interfaces.CommentUpdateData	Uma interface para atualizar dados no objeto Comment, para uso em comment.set({ ... }).
Visio.Interfaces.DocumentData	Uma interface que descreve os dados retornados chamando document.toJSON().
Visio.Interfaces.DocumentLoadOptions	Representa a classe Document.
Visio.Interfaces.DocumentUpdateData	Uma interface para atualizar dados no objeto Document, para uso em document.set({ ... }).
Visio.Interfaces.DocumentViewData	Uma interface que descreve os dados retornados chamando documentView.toJSON().
Visio.Interfaces.DocumentViewLoadOptions	Representa a classe DocumentView.
Visio.Interfaces.DocumentViewUpdateData	Uma interface para atualizar dados no objeto DocumentView, para uso em documentView.set({ ... }).
Visio.Interfaces.HyperlinkCollectionData	Uma interface que descreve os dados retornados chamando hyperlinkCollection.toJSON().
Visio.Interfaces.HyperlinkCollectionLoadOptions	Representa a Coleção de Hiperlinks.
Visio.Interfaces.HyperlinkCollectionUpdateData	Uma interface para atualizar dados no objeto HyperlinkCollection, para uso em hyperlinkCollection.set({ ... }).
Visio.Interfaces.HyperlinkData	Uma interface que descreve os dados retornados chamando hyperlink.toJSON().
Visio.Interfaces.HyperlinkLoadOptions	Representa o Hiperlink.
Visio.Interfaces.PageCollectionData	Uma interface que descreve os dados retornados chamando pageCollection.toJSON().
Visio.Interfaces.PageCollectionLoadOptions	Representa uma coleção de todos os objetos da Página que fazem parte do documento.
Visio.Interfaces.PageCollectionUpdateData	Uma interface para atualizar dados no objeto PageCollection, para uso em pageCollection.set({ ... }).
Visio.Interfaces.PageData	Uma interface que descreve os dados retornados chamando page.toJSON().
Visio.Interfaces.PageLoadOptions	Representa a classe Page.
Visio.Interfaces.PageUpdateData	Uma interface para atualizar dados no objeto Page, para uso em page.set({ ... }).
Visio.Interfaces.PageViewData	Uma interface que descreve os dados retornados chamando pageView.toJSON().
Visio.Interfaces.PageViewLoadOptions	Representa a classe PageView.
Visio.Interfaces.PageViewUpdateData	Uma interface para atualizar dados no objeto PageView, para uso em pageView.set({ ... }).
Visio.Interfaces.SelectionData	Uma interface que descreve os dados retornados chamando selection.toJSON().
Visio.Interfaces.ShapeCollectionData	Uma interface que descreve os dados retornados chamando shapeCollection.toJSON().
Visio.Interfaces.ShapeCollectionLoadOptions	Representa a Coleção de Formas.
Visio.Interfaces.ShapeCollectionUpdateData	Uma interface para atualizar dados no objeto ShapeCollection, para uso em shapeCollection.set({ ... }).
Visio.Interfaces.ShapeData	Uma interface que descreve os dados retornados chamando shape.toJSON().
Visio.Interfaces.ShapeDataItemCollectionData	Uma interface que descreve os dados retornados chamando shapeDataItemCollection.toJSON().
Visio.Interfaces.ShapeDataItemCollectionLoadOptions	Representa o ShapeDataItemCollection de uma determinada Forma.
Visio.Interfaces.ShapeDataItemCollectionUpdateData	Uma interface para atualizar dados no objeto ShapeDataItemCollection, para uso em shapeDataItemCollection.set({ ... }).
Visio.Interfaces.ShapeDataItemData	Uma interface que descreve os dados retornados chamando shapeDataItem.toJSON().
Visio.Interfaces.ShapeDataItemLoadOptions	Representa o ShapeDataItem.
Visio.Interfaces.ShapeLoadOptions	Representa a classe Shape.
Visio.Interfaces.ShapeUpdateData	Uma interface para atualizar dados no objeto Shape, para uso em shape.set({ ... }).
Visio.Interfaces.ShapeViewData	Uma interface que descreve os dados retornados chamando shapeView.toJSON().
Visio.Interfaces.ShapeViewLoadOptions	Representa a classe ShapeView.
Visio.Interfaces.ShapeViewUpdateData	Uma interface para atualizar dados no objeto ShapeView, para uso em shapeView.set({ ... }).
Visio.PageLoadCompleteEventArgs	Fornece informações sobre a página que disparou o evento PageLoadComplete.
Visio.PageRenderCompleteEventArgs	Fornece informações sobre a página que levantou o evento PageRenderComplete.
Visio.Position	Representa a Posição do objeto no modo de exibição.
Visio.SelectionChangedEventArgs	Fornece informações sobre o conjunto de forma que o disparou o evento SelectionChanged.
Visio.ShapeMouseEnterEventArgs	Fornece informações sobre a forma que levantou o evento ShapeMouseEnter.
Visio.ShapeMouseLeaveEventArgs	Fornece informações sobre a forma que gerou o evento ShapeMouseLeave.
Visio.TaskPaneStateChangedEventArgs	Fornece informações sobre o evento TaskPaneStateChanged.

Enumerações

Visio.ColumnType	Representa o tipo de valores de coluna.
Visio.ConnectorDirection	Direção do conector no diagrama DataVisualizer.
Visio.CrossFunctionalFlowchartOrientation	Representa a orientação do diagrama fluxograma funcional cruzado.
Visio.DataSourceType	Representa o tipo de origem para a conexão de dados.
Visio.DataValidationErrorType	Representa os tipos de erro de validação de dados.
Visio.DataVisualizerDiagramOperationType	Tipo da operação Diagrama do Visualizador de Dados
Visio.DataVisualizerDiagramResultType	Resultado das operações do Diagrama do Visualizador de Dados.
Visio.DataVisualizerDiagramType	Diagramtype para diagramas do Visualizador de Dados.
Visio.ErrorCodes
Visio.EventType	EventType representa o tipo de eventos que o Host dá suporte.
Visio.LayoutVariant	Representa o tipo de layout.
Visio.MessageType	MessageType representa o tipo de mensagem quando o evento é disparado do Host.
Visio.OverlayHorizontalAlignment	Representa o Alinhamento Horizontal da Sobreposição em relação à forma.
Visio.OverlayType	Representa o tipo de sobreposição.
Visio.OverlayVerticalAlignment	Representa o Alinhamento Vertical da Sobreposição em relação à forma.
Visio.TaskPaneType	TaskPaneType representa os tipos de TaskPanes de Primeira Parte com suporte por Host por meio de APIs. Usado no caso de Mostrar API TaskPane, TaskPane State Changed ou eventos semelhantes.
Visio.ToolBarType	IDs da barra de ferramentas do aplicativo.

Funções

Visio.run(batch)	Executa um script em lote que executa ações no modelo de objeto do Visio usando um novo contexto de solicitação. Quando a promessa for resolvida, todos os objetos rastreados que foram alocados automaticamente durante a execução serão liberados.
Visio.run(object, batch)	Executa um script em lote que executa ações no modelo de objeto visio, usando o contexto de solicitação de um objeto de API criado anteriormente.
Visio.run(objects, batch)	Executa um script em lote que executa ações no modelo de objeto visio, usando o contexto de solicitação de objetos de API criados anteriormente.
Visio.run(contextObject, batch)	Executa um script em lote que executa ações no modelo de objeto do Visio, usando o RequestContext de um objeto criado anteriormente. Quando a promessa for resolvida, todos os objetos rastreados que foram alocados automaticamente durante a execução serão liberados.

Detalhes da função

Visio.run(batch)

Executa um script em lote que executa ações no modelo de objeto do Visio usando um novo contexto de solicitação. Quando a promessa for resolvida, todos os objetos rastreados que foram alocados automaticamente durante a execução serão liberados.

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

Parâmetros

batch

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

Uma função que usa um Visio.RequestContext e retorna uma promessa (normalmente, apenas o resultado de "context.sync()"). O parâmetro de contexto facilita as solicitações para o aplicativo Visio. Como o suplemento do Office e o aplicativo Visio são executados em dois processos diferentes, o contexto de solicitação é necessário para obter acesso ao modelo de objeto visio do suplemento.

Retornos

Promise<T>

Visio.run(object, batch)

Executa um script em lote que executa ações no modelo de objeto visio, usando o contexto de solicitação de um objeto de API criado anteriormente.

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

Parâmetros

object

OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession

Um objeto de API criado anteriormente. O lote usará o mesmo contexto de solicitação que o objeto passado, o que significa que todas as alterações aplicadas ao objeto serão captadas por "context.sync()".

batch

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

Uma função que usa um Visio.RequestContext e retorna uma promessa (normalmente, apenas o resultado de "context.sync()"). Quando a promessa for resolvida, todos os objetos rastreados que foram alocados automaticamente durante a execução serão liberados.

Retornos

Promise<T>

Visio.run(objects, batch)

Executa um script em lote que executa ações no modelo de objeto visio, usando o contexto de solicitação de objetos de API criados anteriormente.

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

Parâmetros

objects

OfficeExtension.ClientObject[]

Uma matriz de objetos de API criados anteriormente. A matriz será validada para garantir que todos os objetos compartilhem o mesmo contexto. O lote usará esse contexto de solicitação compartilhada, o que significa que todas as alterações aplicadas a esses objetos serão captadas por "context.sync()".

batch

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

Uma função que usa um Visio.RequestContext e retorna uma promessa (normalmente, apenas o resultado de "context.sync()"). Quando a promessa for resolvida, todos os objetos rastreados que foram alocados automaticamente durante a execução serão liberados.

Retornos

Promise<T>

Visio.run(contextObject, batch)

Executa um script em lote que executa ações no modelo de objeto do Visio, usando o RequestContext de um objeto criado anteriormente. Quando a promessa for resolvida, todos os objetos rastreados que foram alocados automaticamente durante a execução serão liberados.

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

Parâmetros

contextObject

OfficeExtension.ClientRequestContext

Um Visio.RequestContext criado anteriormente. Esse contexto será usado novamente pela função de lote (em vez de ter um novo contexto criado). Isso significa que o lote poderá obter alterações feitas em objetos de API existentes, se esses objetos forem derivados desse mesmo contexto.

batch

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

Uma função que recebe um RequestContext e retorna uma promessa (normalmente, apenas o resultado de "context.sync()"). O parâmetro de contexto facilita as solicitações para o aplicativo Visio. Como o suplemento do Office e o aplicativo Visio são executados em dois processos diferentes, o RequestContext é necessário para obter acesso ao modelo de objeto visio do suplemento.

Retornos

Promise<T>