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. Uma vez que o suplemento do Office e a aplicação visio são executados em dois processos diferentes, o contexto do pedido é necessário para obter acesso ao modelo de objetos do Visio a partir 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 êxito ou falha do evento DocumentLoadComplete.

Visio.Highlight

Representa os dados de realce adicionados à forma.

Visio.Interfaces.ApplicationData

Uma interface que descreve os dados devolvidos ao chamar application.toJSON().

Visio.Interfaces.ApplicationLoadOptions

Representa o Aplicativo.

Visio.Interfaces.ApplicationUpdateData

Uma interface para atualizar dados no objeto Aplicação, para utilização no application.set({ ... }).

Visio.Interfaces.CollectionLoadOptions

Fornece formas de carregar propriedades de apenas um subconjunto de membros de uma coleção.

Visio.Interfaces.CommentCollectionData

Uma interface que descreve os dados devolvidos ao chamar commentCollection.toJSON().

Visio.Interfaces.CommentCollectionLoadOptions

Representa o CommentCollection para determinada Forma.

Visio.Interfaces.CommentCollectionUpdateData

Uma interface para atualizar dados no objeto CommentCollection, para utilização no commentCollection.set({ ... }).

Visio.Interfaces.CommentData

Uma interface que descreve os dados devolvidos ao chamar comment.toJSON().

Visio.Interfaces.CommentLoadOptions

Representa o Comentário.

Visio.Interfaces.CommentUpdateData

Uma interface para atualizar dados no objeto Comentário, para utilização no comment.set({ ... }).

Visio.Interfaces.DocumentData

Uma interface que descreve os dados devolvidos ao chamar document.toJSON().

Visio.Interfaces.DocumentLoadOptions

Representa a classe Document.

Visio.Interfaces.DocumentUpdateData

Uma interface para atualizar dados no objeto Documento, para utilização no document.set({ ... }).

Visio.Interfaces.DocumentViewData

Uma interface que descreve os dados devolvidos ao chamar documentView.toJSON().

Visio.Interfaces.DocumentViewLoadOptions

Representa a classe DocumentView.

Visio.Interfaces.DocumentViewUpdateData

Uma interface para atualizar dados no objeto DocumentView, para utilização no documentView.set({ ... }).

Visio.Interfaces.HyperlinkCollectionData

Uma interface que descreve os dados devolvidos ao chamar hyperlinkCollection.toJSON().

Visio.Interfaces.HyperlinkCollectionLoadOptions

Representa a Coleção de Hiperlinks.

Visio.Interfaces.HyperlinkCollectionUpdateData

Uma interface para atualizar dados no objeto HyperlinkCollection, para utilização no hyperlinkCollection.set({ ... }).

Visio.Interfaces.HyperlinkData

Uma interface que descreve os dados devolvidos ao chamar hyperlink.toJSON().

Visio.Interfaces.HyperlinkLoadOptions

Representa o Hiperlink.

Visio.Interfaces.PageCollectionData

Uma interface que descreve os dados devolvidos ao chamar 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 utilização no pageCollection.set({ ... }).

Visio.Interfaces.PageData

Uma interface que descreve os dados devolvidos ao chamar page.toJSON().

Visio.Interfaces.PageLoadOptions

Representa a classe Page.

Visio.Interfaces.PageUpdateData

Uma interface para atualizar dados no objeto Página, para utilização no page.set({ ... }).

Visio.Interfaces.PageViewData

Uma interface que descreve os dados devolvidos ao chamar pageView.toJSON().

Visio.Interfaces.PageViewLoadOptions

Representa a classe PageView.

Visio.Interfaces.PageViewUpdateData

Uma interface para atualizar dados no objeto PageView, para utilização no pageView.set({ ... }).

Visio.Interfaces.SelectionData

Uma interface que descreve os dados devolvidos ao chamar selection.toJSON().

Visio.Interfaces.ShapeCollectionData

Uma interface que descreve os dados devolvidos ao chamar shapeCollection.toJSON().

Visio.Interfaces.ShapeCollectionLoadOptions

Representa a Coleção de Formas.

Visio.Interfaces.ShapeCollectionUpdateData

Uma interface para atualizar dados no objeto ShapeCollection, para utilização no shapeCollection.set({ ... }).

Visio.Interfaces.ShapeData

Uma interface que descreve os dados devolvidos ao chamar shape.toJSON().

Visio.Interfaces.ShapeDataItemCollectionData

Uma interface que descreve os dados devolvidos ao chamar shapeDataItemCollection.toJSON().

Visio.Interfaces.ShapeDataItemCollectionLoadOptions

Representa o ShapeDataItemCollection de uma determinada Forma.

Visio.Interfaces.ShapeDataItemCollectionUpdateData

Uma interface para atualizar dados no objeto ShapeDataItemCollection, para utilização no shapeDataItemCollection.set({ ... }).

Visio.Interfaces.ShapeDataItemData

Uma interface que descreve os dados devolvidos ao chamar 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 Forma, para utilização no shape.set({ ... }).

Visio.Interfaces.ShapeViewData

Uma interface que descreve os dados devolvidos ao chamar shapeView.toJSON().

Visio.Interfaces.ShapeViewLoadOptions

Representa a classe ShapeView.

Visio.Interfaces.ShapeViewUpdateData

Uma interface para atualizar dados no objeto ShapeView, para utilização no 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 elevou o evento ShapeMouseEnter.

Visio.ShapeMouseLeaveEventArgs

Fornece informações sobre a forma que elevou 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 do DataVisualizer.

Visio.CrossFunctionalFlowchartOrientation

Representa a orientação do diagrama de Fluxograma Multifuncional.

Visio.DataSourceType

Representa o tipo de origem para a ligação de dados.

Visio.DataValidationErrorType

Representa os tipos de erro de validação de dados.

Visio.DataVisualizerDiagramOperationType

Tipo da operação Diagrama de Visualização de Dados

Visio.DataVisualizerDiagramResultType

Resultado das operações do Diagrama de Visualização de Dados.

Visio.DataVisualizerDiagramType

DiagramType para diagramas de Visualização de Dados.

Visio.ErrorCodes
Visio.EventType

EventType representa o tipo de eventos suportados pelo Anfitrião.

Visio.LayoutVariant

Representa o tipo de esquema.

Visio.MessageType

MessageType representa o tipo de mensagem quando o evento é acionado do Anfitrião.

Visio.OverlayHorizontalAlignment

Representa o Alinhamento Horizontal da Sobreposição relativa à forma.

Visio.OverlayType

Representa o tipo de sobreposição.

Visio.OverlayVerticalAlignment

Representa o Alinhamento Vertical da Sobreposição relativa à forma.

Visio.TaskPaneType

TaskPaneType representa os tipos de TaskPanes originais suportados pelo Anfitrião através de APIs. Utilizado no caso de Mostrar API taskPane, Estado do Painel de Tarefas Alterado ou eventos semelhantes.

Visio.ToolBarType

IDs da barra de ferramentas da aplicação.

Funções

Visio.run(batch)

Executa um script de lote que executa ações no modelo de objetos do Visio com um novo contexto de pedido. Quando a promessa for resolvida, todos os objetos controlados que foram alocados automaticamente durante a execução serão libertados.

Visio.run(object, batch)

Executa um script de lote que executa ações no modelo de objetos do Visio, com o contexto de pedido de um objeto de API criado anteriormente.

Visio.run(objects, batch)

Executa um script de lote que executa ações no modelo de objetos do Visio, com o contexto de pedido de objetos de API criados anteriormente.

Visio.run(contextObject, batch)

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

Detalhes da função

Visio.run(batch)

Executa um script de lote que executa ações no modelo de objetos do Visio com um novo contexto de pedido. Quando a promessa for resolvida, todos os objetos controlados que foram alocados automaticamente durante a execução serão libertados.

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

Parâmetros

batch

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

Uma função que recebe um Visio.RequestContext e devolve uma promessa (normalmente, apenas o resultado de context.sync()). O parâmetro de contexto facilita os pedidos para a aplicação visio. Uma vez que o suplemento do Office e a aplicação visio são executados em dois processos diferentes, o contexto do pedido é necessário para obter acesso ao modelo de objetos do Visio a partir do suplemento.

Retornos

Promise<T>

Visio.run(object, batch)

Executa um script de lote que executa ações no modelo de objetos do Visio, com o contexto de pedido 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 utilizará o mesmo contexto de pedido que o objeto transmitido, o que significa que todas as alterações aplicadas ao objeto serão recolhidas pelo context.sync().

batch

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

Uma função que recebe um Visio.RequestContext e devolve uma promessa (normalmente, apenas o resultado de context.sync()). Quando a promessa for resolvida, todos os objetos controlados que foram alocados automaticamente durante a execução serão libertados.

Retornos

Promise<T>

Visio.run(objects, batch)

Executa um script de lote que executa ações no modelo de objetos do Visio, com o contexto de pedido 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 partilham o mesmo contexto. O lote utilizará este contexto de pedido partilhado, o que significa que todas as alterações aplicadas a estes objetos serão recolhidas pelo context.sync().

batch

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

Uma função que recebe um Visio.RequestContext e devolve uma promessa (normalmente, apenas o resultado de context.sync()). Quando a promessa for resolvida, todos os objetos controlados que foram alocados automaticamente durante a execução serão libertados.

Retornos

Promise<T>

Visio.run(contextObject, batch)

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

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

Parâmetros

contextObject
OfficeExtension.ClientRequestContext

Visio.RequestContext criado anteriormente. Este contexto será reutilizado pela função batch (em vez de criar um novo contexto). Isto significa que o lote poderá recolher as alterações efetuadas aos objetos de API existentes, caso esses objetos tenham sido derivados deste mesmo contexto.

batch

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

Uma função que recebe um RequestContext e devolve uma promessa (normalmente, apenas o resultado de context.sync()). O parâmetro de contexto facilita os pedidos para a aplicação visio. Uma vez que o suplemento do Office e a aplicação visio são executados em dois processos diferentes, o RequestContext é necessário para obter acesso ao modelo de objetos do Visio a partir do suplemento.

Retornos

Promise<T>