Visio.Document class

Ссылка

Пакет:: visio

Представляет класс Document.

Extends: OfficeExtension.ClientObject

Свойства

application	Представляет экземпляр приложения Visio, содержащий этот документ.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
pages	Представляет коллекцию страниц, связанных с документом.
view	Возвращает объект DocumentView.

Методы

getActivePage()	Возвращает активную страницу документа.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setActivePage(PageName)	Задает активную страницу документа.
setMockData(data)	Настройка макетных данных
showTaskPane(taskPaneType, initialProps, show)	Отображает или скрывает область задач. Это будет использоваться надстройками Excel и другими сторонними приложениями, которые внедряют документ Visio для отображения или скрытия области задач.
showTaskPane(taskPaneTypeString, initialProps, show)	Отображает или скрывает область задач. Это будет использоваться надстройками Excel и другими сторонними приложениями, которые внедряют документ Visio для отображения или скрытия области задач.
startDataRefresh()	Запускает обновление данных в диаграмме, для всех страниц.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный объект Visio.Document является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Visio.Interfaces.DocumentData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

События

onDataRefreshComplete	Происходит при обновлении данных на схеме.
onDocumentError	Происходит, когда в сеансе произошла ожидаемая или непредвиденная ошибка.
onDocumentLoadComplete	Происходит при загрузке, обновлении или изменении документа.
onPageLoadComplete	Происходит после завершения загрузки страницы.
onSelectionChanged	Происходит при изменении текущего выбора фигур.
onShapeMouseEnter	Происходит, когда пользователь перемещает указатель мыши в ограничивающий прямоугольник фигуры.
onShapeMouseLeave	Происходит, когда пользователь перемещает мышь из ограничивающего прямоугольника фигуры.
onTaskPaneStateChanged	Происходит при изменении состояния области задач.

Сведения о свойстве

application

Представляет экземпляр приложения Visio, содержащий этот документ.

readonly application: Visio.Application;

Значение свойства

Visio.Application

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Visio.RequestContext

pages

Представляет коллекцию страниц, связанных с документом.

readonly pages: Visio.PageCollection;

Значение свойства

Visio.PageCollection

Примеры

Visio.run(session, function (ctx) {
    const pages = ctx.document.pages;
    const pageCount = pages.getCount();
    return ctx.sync().then(function () {
        console.log("Pages Count: " +pageCount.value);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

view

Возвращает объект DocumentView.

readonly view: Visio.DocumentView;

Значение свойства

Visio.DocumentView

Сведения о методе

getActivePage()

Возвращает активную страницу документа.

getActivePage(): Visio.Page;

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

Visio.Page

Примеры

Visio.run(session, function (ctx) {
    const document = ctx.document;
    const activePage = document.getActivePage();
    activePage.load("name");
    return ctx.sync().then(function () {
        console.log("pageName: " +activePage.name);
    });   
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Visio.Interfaces.DocumentLoadOptions): Visio.Document;

Параметры

options: Visio.Interfaces.DocumentLoadOptions

Предоставляет параметры свойств объекта для загрузки.

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

Visio.Document

load(propertyNames)

load(propertyNames?: string | string[]): Visio.Document;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

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

Visio.Document

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Visio.Document;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

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

Visio.Document

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Visio.Interfaces.DocumentUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Visio.Document): void;

Параметры

properties: Visio.Document

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

void

setActivePage(PageName)

Задает активную страницу документа.

setActivePage(PageName: string): void;

Параметры

PageName: string

Имя страницы

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

void

Примеры

Visio.run(session, function (ctx) {
    const document = ctx.document;
    const pageName = "Page-1";
    document.setActivePage(pageName);
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

setMockData(data)

Настройка макетных данных

setMockData(data: Visio.Interfaces.DocumentData): void;

Параметры

data: Visio.Interfaces.DocumentData

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

void

showTaskPane(taskPaneType, initialProps, show)

Отображает или скрывает область задач. Это будет использоваться надстройками Excel и другими сторонними приложениями, которые внедряют документ Visio для отображения или скрытия области задач.

showTaskPane(taskPaneType: Visio.TaskPaneType, initialProps?: any, show?: boolean): void;

Параметры

taskPaneType: Visio.TaskPaneType

Тип области задач 1-й партии. Он может принимать значения из перечисления TaskPaneType

initialProps: any

Необязательный параметр. Это универсальная структура данных, которая будет заполнена начальными данными, необходимыми для инициализации содержимого области задач.

show: boolean

Необязательный параметр. Если задано значение false, будет скрыта указанная область задач.

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

void

showTaskPane(taskPaneTypeString, initialProps, show)

showTaskPane(taskPaneTypeString: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void;

Параметры

taskPaneTypeString: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings"

Тип области задач 1-й партии. Он может принимать значения из перечисления TaskPaneType

initialProps: any

show: boolean

Необязательный параметр. Если задано значение false, будет скрыта указанная область задач.

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

void

startDataRefresh()

Запускает обновление данных в диаграмме, для всех страниц.

startDataRefresh(): void;

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

void

Примеры

Visio.run(session, function (ctx) {
    const document = ctx.document;
    document.startDataRefresh();
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Visio.Document является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Visio.Interfaces.DocumentData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Visio.Interfaces.DocumentData;

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

Visio.Interfaces.DocumentData

Сведения о событии

onDataRefreshComplete

Происходит при обновлении данных на схеме.

readonly onDataRefreshComplete: OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>;

Тип события

OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>

onDocumentError

Происходит, когда в сеансе произошла ожидаемая или непредвиденная ошибка.

readonly onDocumentError: OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>;

Тип события

OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>

onDocumentLoadComplete

Происходит при загрузке, обновлении или изменении документа.

readonly onDocumentLoadComplete: OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>;

Тип события

OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>

onPageLoadComplete

Происходит после завершения загрузки страницы.

readonly onPageLoadComplete: OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>;

Тип события

OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>

onSelectionChanged

Происходит при изменении текущего выбора фигур.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>

onShapeMouseEnter

Происходит, когда пользователь перемещает указатель мыши в ограничивающий прямоугольник фигуры.

readonly onShapeMouseEnter: OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>;

Тип события

OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>

onShapeMouseLeave

Происходит, когда пользователь перемещает мышь из ограничивающего прямоугольника фигуры.

readonly onShapeMouseLeave: OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>;

Тип события

OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>

onTaskPaneStateChanged

Происходит при изменении состояния области задач.

readonly onTaskPaneStateChanged: OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>

Share via

Visio.Document class

Комментарии

Свойства

Методы

События

Сведения о свойстве

application

Значение свойства

Комментарии

context

Значение свойства

pages

Значение свойства

Комментарии

Примеры

view

Значение свойства

Комментарии

Сведения о методе

getActivePage()

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

Комментарии

Примеры

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

setActivePage(PageName)

Параметры

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

Комментарии

Примеры

setMockData(data)

Параметры

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

showTaskPane(taskPaneType, initialProps, show)

Параметры

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

Комментарии

showTaskPane(taskPaneTypeString, initialProps, show)

Параметры

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

Комментарии

startDataRefresh()

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

Комментарии

Примеры

toJSON()

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

Сведения о событии

onDataRefreshComplete

Тип события

Комментарии

onDocumentError

Тип события

Комментарии

onDocumentLoadComplete

Тип события

Комментарии

onPageLoadComplete

Тип события

Комментарии

onSelectionChanged

Тип события

Комментарии

onShapeMouseEnter

Тип события

Комментарии