Visio.PageView class

Пакет:

visio

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: 1.1 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
zoom	Получение и настройка уровня масштаба страницы. Значение может находиться в диапазоне от 10 до 400 и обозначает процент масштабирования.

Методы

centerViewportOnShape(ShapeId)	Сдвигает документ Visio так, чтобы разместить указанную фигуру по центру.
fitToWindow()	Выравнивает Page по краям текущего окна.
getPosition()	Возвращает объект, который определяет положение страницы в представлении.
getSelection()	Представляет выделение на странице.
isShapeInViewport(Shape)	Проверяет, находится ли фигура в представлении страницы.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setMockData(data)	Настройка макетных данных
setPosition(Position)	Задает положение страницы в представлении.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Visio.PageView является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Visio.Interfaces.PageViewData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

context

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

context: RequestContext;

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

Visio.RequestContext

zoom

Получение и настройка уровня масштаба страницы. Значение может находиться в диапазоне от 10 до 400 и обозначает процент масштабирования.

zoom: number;

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

number

Комментарии

[ Набор API: 1.1 ]

Примеры

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

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

centerViewportOnShape(ShapeId)

Сдвигает документ Visio так, чтобы разместить указанную фигуру по центру.

centerViewportOnShape(ShapeId: number): void;

Параметры

ShapeId

number

Элемент ShapeId, который будет виден в центре.

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

void

Комментарии

[ Набор API: 1.1 ]

Примеры

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    activePage.view.centerViewportOnShape(shape.Id);
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

fitToWindow()

Выравнивает Page по краям текущего окна.

fitToWindow(): void;

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

void

Комментарии

[ Набор API: 1.1 ]

getPosition()

Возвращает объект, который определяет положение страницы в представлении.

getPosition(): OfficeExtension.ClientResult<Visio.Position>;

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

OfficeExtension.ClientResult<Visio.Position>

Комментарии

[ Набор API: 1.1 ]

getSelection()

Представляет выделение на странице.

getSelection(): Visio.Selection;

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

Visio.Selection

Комментарии

[ Набор API: 1.1 ]

isShapeInViewport(Shape)

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

isShapeInViewport(Shape: Visio.Shape): OfficeExtension.ClientResult<boolean>;

Параметры

Shape

Visio.Shape

Фигура, которую необходимо проверить.

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

OfficeExtension.ClientResult<boolean>

Комментарии

[ Набор API: 1.1 ]

load(options)

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

load(options?: Visio.Interfaces.PageViewLoadOptions): Visio.PageView;

Параметры

options

Visio.Interfaces.PageViewLoadOptions

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

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

Visio.PageView

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Visio.PageView

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Visio.PageView

set(properties, options)

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

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

Параметры

properties

Visio.Interfaces.PageViewUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Visio.PageView): void;

Параметры

properties

Visio.PageView

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

void

setMockData(data)

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

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

Параметры

data

Visio.Interfaces.PageViewData

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

void

setPosition(Position)

Задает положение страницы в представлении.

setPosition(Position: Visio.Position): void;

Параметры

Position

Visio.Position

Объект Position, который указывает новое положение страницы в представлении.

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

void

Комментарии

[ Набор API: 1.1 ]

toJSON()

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

toJSON(): Visio.Interfaces.PageViewData;

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

Visio.Interfaces.PageViewData