visio package

Классы

Visio.Application	Представляет Application.
Visio.Comment	Представляет примечание.
Visio.CommentCollection	Представляет CommentCollection для заданной фигуры.
Visio.Document	Представляет класс Document.
Visio.DocumentView	Представляет класс DocumentView.
Visio.Hyperlink	Представляет Hyperlink.
Visio.HyperlinkCollection	Представляет коллекцию Hyperlink.
Visio.Page	Представляет класс Page.
Visio.PageCollection	Представляет коллекцию объектов Page, включенных в документ.
Visio.PageView	Представляет класс PageView.
Visio.RequestContext	Объект RequestContext обеспечивает отправку запросов приложению Visio. Так как надстройка Office и приложение Visio выполняются в двух разных процессах, контекст запроса необходим для получения доступа к объектной модели Visio из надстройки.
Visio.Selection	Представляет выделение на странице.
Visio.Shape	Представляет класс Shape.
Visio.ShapeCollection	Представляет коллекцию Shape.
Visio.ShapeDataItem	Представляет ShapeDataItem.
Visio.ShapeDataItemCollection	Представляет ShapeDataItemCollection для заданного объекта Shape.
Visio.ShapeView	Представляет класс ShapeView.

Интерфейсы

Visio.BoundingBox	Представляет BoundingBox фигуры.
Visio.DataRefreshCompleteEventArgs	Предоставляет сведения о документе, который вызвал событие DataRefreshComplete.
Visio.DocumentErrorEventArgs	Предоставляет сведения о событии DocumentError.
Visio.DocumentLoadCompleteEventArgs	Предоставляет сведения об успешности или неудаче события DocumentLoadComplete.
Visio.Highlight	Представляет данные выделения, добавленные к фигуре.
Visio.Interfaces.ApplicationData	Интерфейс, описывающий данные, возвращаемые вызовом `application.toJSON()`.
Visio.Interfaces.ApplicationLoadOptions	Представляет Application.
Visio.Interfaces.ApplicationUpdateData	Интерфейс для обновления данных об объекте Application для использования в `application.set({ ... })`.
Visio.Interfaces.CollectionLoadOptions	Предоставляет способы загрузки свойств только подмножества членов семейства.
Visio.Interfaces.CommentCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом `commentCollection.toJSON()`.
Visio.Interfaces.CommentCollectionLoadOptions	Представляет CommentCollection для заданной фигуры.
Visio.Interfaces.CommentCollectionUpdateData	Интерфейс для обновления данных в объекте CommentCollection для использования в `commentCollection.set({ ... })`.
Visio.Interfaces.CommentData	Интерфейс, описывающий данные, возвращаемые вызовом `comment.toJSON()`.
Visio.Interfaces.CommentLoadOptions	Представляет примечание.
Visio.Interfaces.CommentUpdateData	Интерфейс для обновления данных об объекте Comment для использования в `comment.set({ ... })`.
Visio.Interfaces.DocumentData	Интерфейс, описывающий данные, возвращаемые вызовом `document.toJSON()`.
Visio.Interfaces.DocumentLoadOptions	Представляет класс Document.
Visio.Interfaces.DocumentUpdateData	Интерфейс для обновления данных в объекте Document для использования в `document.set({ ... })`.
Visio.Interfaces.DocumentViewData	Интерфейс, описывающий данные, возвращаемые вызовом `documentView.toJSON()`.
Visio.Interfaces.DocumentViewLoadOptions	Представляет класс DocumentView.
Visio.Interfaces.DocumentViewUpdateData	Интерфейс для обновления данных в объекте DocumentView для использования в `documentView.set({ ... })`.
Visio.Interfaces.HyperlinkCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом `hyperlinkCollection.toJSON()`.
Visio.Interfaces.HyperlinkCollectionLoadOptions	Представляет коллекцию Hyperlink.
Visio.Interfaces.HyperlinkCollectionUpdateData	Интерфейс обновления данных в объекте HyperlinkCollection для использования в `hyperlinkCollection.set({ ... })`.
Visio.Interfaces.HyperlinkData	Интерфейс, описывающий данные, возвращаемые вызовом `hyperlink.toJSON()`.
Visio.Interfaces.HyperlinkLoadOptions	Представляет Hyperlink.
Visio.Interfaces.PageCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом `pageCollection.toJSON()`.
Visio.Interfaces.PageCollectionLoadOptions	Представляет коллекцию объектов Page, включенных в документ.
Visio.Interfaces.PageCollectionUpdateData	Интерфейс обновления данных в объекте PageCollection для использования в `pageCollection.set({ ... })`.
Visio.Interfaces.PageData	Интерфейс, описывающий данные, возвращаемые вызовом `page.toJSON()`.
Visio.Interfaces.PageLoadOptions	Представляет класс Page.
Visio.Interfaces.PageUpdateData	Интерфейс для обновления данных в объекте Page для использования в `page.set({ ... })`.
Visio.Interfaces.PageViewData	Интерфейс, описывающий данные, возвращаемые вызовом `pageView.toJSON()`.
Visio.Interfaces.PageViewLoadOptions	Представляет класс PageView.
Visio.Interfaces.PageViewUpdateData	Интерфейс для обновления данных в объекте PageView для использования в `pageView.set({ ... })`.
Visio.Interfaces.SelectionData	Интерфейс, описывающий данные, возвращаемые вызовом `selection.toJSON()`.
Visio.Interfaces.ShapeCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом `shapeCollection.toJSON()`.
Visio.Interfaces.ShapeCollectionLoadOptions	Представляет коллекцию Shape.
Visio.Interfaces.ShapeCollectionUpdateData	Интерфейс обновления данных в объекте ShapeCollection для использования в `shapeCollection.set({ ... })`.
Visio.Interfaces.ShapeData	Интерфейс, описывающий данные, возвращаемые вызовом `shape.toJSON()`.
Visio.Interfaces.ShapeDataItemCollectionData	Интерфейс, описывающий данные, возвращаемые вызовом `shapeDataItemCollection.toJSON()`.
Visio.Interfaces.ShapeDataItemCollectionLoadOptions	Представляет ShapeDataItemCollection для заданного объекта Shape.
Visio.Interfaces.ShapeDataItemCollectionUpdateData	Интерфейс для обновления данных в объекте ShapeDataItemCollection для использования в `shapeDataItemCollection.set({ ... })`.
Visio.Interfaces.ShapeDataItemData	Интерфейс, описывающий данные, возвращаемые вызовом `shapeDataItem.toJSON()`.
Visio.Interfaces.ShapeDataItemLoadOptions	Представляет ShapeDataItem.
Visio.Interfaces.ShapeLoadOptions	Представляет класс Shape.
Visio.Interfaces.ShapeUpdateData	Интерфейс обновления данных в объекте Shape для использования в `shape.set({ ... })`.
Visio.Interfaces.ShapeViewData	Интерфейс, описывающий данные, возвращаемые вызовом `shapeView.toJSON()`.
Visio.Interfaces.ShapeViewLoadOptions	Представляет класс ShapeView.
Visio.Interfaces.ShapeViewUpdateData	Интерфейс для обновления данных в объекте ShapeView для использования в `shapeView.set({ ... })`.
Visio.PageLoadCompleteEventArgs	Предоставляет сведения о странице, которая вызвала событие PageLoadComplete.
Visio.PageRenderCompleteEventArgs	Предоставляет сведения о странице, которая вызвала событие PageRenderComplete.
Visio.Position	Представляет положение объекта в представлении.
Visio.SelectionChangedEventArgs	Предоставляет сведения о коллекции фигур, которая вызвал событие SelectionChanged.
Visio.ShapeMouseEnterEventArgs	Предоставляет сведения о фигуре, которая вызвала событие ShapeMouseEnter.
Visio.ShapeMouseLeaveEventArgs	Предоставляет сведения о фигуре, которая вызвала событие ShapeMouseLeave.
Visio.TaskPaneStateChangedEventArgs	Предоставляет сведения о событии TaskPaneStateChanged.

Перечисления

Visio.ColumnType	Представляет тип значений столбца.
Visio.ConnectorDirection	Направление соединителя на схеме DataVisualizer.
Visio.CrossFunctionalFlowchartOrientation	Ориентация функциональной блок-схемы.
Visio.DataSourceType	Представляет тип источника для подключения к данным.
Visio.DataValidationErrorType	Представляет типы ошибок проверки данных.
Visio.DataVisualizerDiagramOperationType	Тип операции "Диаграмма" визуализатора данных
Visio.DataVisualizerDiagramResultType	Результат операций диаграммы визуализатора данных.
Visio.DataVisualizerDiagramType	DiagramType для схем визуализатора данных.
Visio.ErrorCodes
Visio.EventType	EventType представляет тип событий, поддерживаемых узлом.
Visio.LayoutVariant	Представляет тип макета.
Visio.MessageType	MessageType представляет тип сообщения, когда событие запускается из Host.
Visio.OverlayHorizontalAlignment	Представляет горизонтальное выравнивание наложения относительно фигуры.
Visio.OverlayType	Представляет тип наложения.
Visio.OverlayVerticalAlignment	Представляет вертикальное выравнивание наложения относительно фигуры.
Visio.TaskPaneType	TaskPaneType представляет типы собственных панелей задач, поддерживаемых узлом через API. Используется в случае событий "Показать API TaskPane", "Состояние TaskPane изменилось" или аналогичных событий.
Visio.ToolBarType	Идентификаторы панели инструментов приложения.

Функции

Visio.run(batch)	Запускает пакетный сценарий, выполняющий действия с объектной моделью Visio, используя новый контекст запроса. Когда обещание будет разрешено, все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.
Visio.run(object, batch)	Запускает пакетный сценарий, который выполняет действия с объектной моделью Visio, используя контекст запроса ранее созданного объекта API.
Visio.run(objects, batch)	Запускает пакетный сценарий, который выполняет действия с объектной моделью Visio, используя контекст запроса ранее созданных объектов API.
Visio.run(contextObject, batch)	Запускает пакетный сценарий, который выполняет действия с объектной моделью Visio, используя RequestContext ранее созданного объекта. Когда обещание будет разрешено, все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.

Visio.run(batch)

Запускает пакетный сценарий, выполняющий действия с объектной моделью Visio, используя новый контекст запроса. Когда обещание будет разрешено, все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.

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

Параметры

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

Функция, принимающая Visio.RequestContext и возвращающая обещание (как правило, только результат ).context.sync() Параметр контекста упрощает запросы к приложению Visio. Так как надстройка Office и приложение Visio выполняются в двух разных процессах, контекст запроса необходим для получения доступа к объектной модели Visio из надстройки.

Возвращаемое значение

Promise<T>

Visio.run(object, batch)

Запускает пакетный сценарий, который выполняет действия с объектной моделью Visio, используя контекст запроса ранее созданного объекта API.

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

Параметры

object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession

Ранее созданный объект API. Пакет будет использовать тот же контекст запроса, что и переданный объект, что означает, что любые изменения, примененные к объекту, будут подхвачены context.sync().

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

Функция, принимающая Visio.RequestContext и возвращающая обещание (как правило, только результат ).context.sync() Когда обещание будет разрешено, все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.

Возвращаемое значение

Promise<T>

Примеры

// *.run methods automatically create an OfficeExtension.ClientRequestContext
// object to work with the Office file.
Visio.run(session, function (context) {
    const activePage = context.document.getActivePage();
    // Interact with the Visio page... 

    return context.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

Visio.run(objects, batch)

Запускает пакетный сценарий, который выполняет действия с объектной моделью Visio, используя контекст запроса ранее созданных объектов API.

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

Параметры

objects: OfficeExtension.ClientObject[]

Массив ранее созданных объектов API. Массив будет проверен, чтобы убедиться, что все объекты имеют общий контекст. Пакет будет использовать этот общий контекст запроса, что означает, что любые изменения, примененные к этим объектам, будут подхвачены context.sync().

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

Функция, которая принимает Visio.RequestContext и возвращает обещание (как правило, только результат ).context.sync() Когда обещание будет разрешено, все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.

Возвращаемое значение

Promise<T>

Visio.run(contextObject, batch)

Запускает пакетный сценарий, который выполняет действия с объектной моделью Visio, используя RequestContext ранее созданного объекта. Когда обещание будет разрешено, все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.

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

Параметры

contextObject: OfficeExtension.ClientRequestContext

Ранее созданный Visio.RequestContext. Этот контекст будет повторно использован пакетной функцией (вместо создания нового контекста). Это означает, что пакет сможет принять изменения, внесенные в существующие объекты API, если эти объекты были получены из этого же контекста.

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

Функция, которая принимает RequestContext и возвращает обещание (как правило, просто результат ).context.sync() Параметр контекста упрощает запросы к приложению Visio. Так как надстройка Office и приложение Visio выполняются в двух разных процессах, для доступа к объектной модели Visio из надстройки требуется RequestContext.

Возвращаемое значение

Promise<T>

Классы

Интерфейсы

Перечисления

Функции

Сведения о функции

Visio.run(batch)

Параметры

Возвращаемое значение

Visio.run(object, batch)

Параметры

Возвращаемое значение

Примеры

Visio.run(objects, batch)

Параметры

Возвращаемое значение

Visio.run(contextObject, batch)

Параметры

Возвращаемое значение

Обратная связь