Visio.PageView class

Pacote:

visio

Representa a classe PageView.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: 1.1 ]

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
zoom	Obter e definir o nível de Zoom da página. O valor pode estar entre 10 e 400 e denota o percentual de zoom.

Métodos

centerViewportOnShape(ShapeId)	Desloca o desenho do Visio para posicionar a forma especificada no centro da visualização.
fitToWindow()	Ajustar Page à janela atual.
getPosition()	Retorna o objeto position que especifica a posição da página no modo de exibição.
getSelection()	Representa a Seleção na página.
isShapeInViewport(Shape)	Para verificar se a forma está no modo de exibição da página ou não.
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
setMockData(data)	Definir dados simulados
setPosition(Position)	Define a posição da página no modo de exibição.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Visio.PageView original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Visio.Interfaces.PageViewData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Visio.RequestContext

zoom

Obter e definir o nível de Zoom da página. O valor pode estar entre 10 e 400 e denota o percentual de zoom.

zoom: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: 1.1 ]

Exemplos

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));
    }
});

Detalhes do método

centerViewportOnShape(ShapeId)

Desloca o desenho do Visio para posicionar a forma especificada no centro da visualização.

centerViewportOnShape(ShapeId: number): void;

Parâmetros

ShapeId

number

ShapeId a ser exibida no centro.

Retornos

void

Comentários

[ Conjunto de API: 1.1 ]

Exemplos

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()

Ajustar Page à janela atual.

fitToWindow(): void;

Retornos

void

Comentários

[ Conjunto de API: 1.1 ]

getPosition()

Retorna o objeto position que especifica a posição da página no modo de exibição.

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

Retornos

OfficeExtension.ClientResult<Visio.Position>

Comentários

[ Conjunto de API: 1.1 ]

getSelection()

Representa a Seleção na página.

getSelection(): Visio.Selection;

Retornos

Visio.Selection

Comentários

[ Conjunto de API: 1.1 ]

isShapeInViewport(Shape)

Para verificar se a forma está no modo de exibição da página ou não.

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

Parâmetros

Shape

Visio.Shape

Forma a ser verificada.

Retornos

OfficeExtension.ClientResult<boolean>

Comentários

[ Conjunto de API: 1.1 ]

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options

Visio.Interfaces.PageViewLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Visio.PageView

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Visio.PageView

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Visio.PageView

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties

Visio.Interfaces.PageViewUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Visio.PageView): void;

Parâmetros

properties

Visio.PageView

Retornos

void

setMockData(data)

Definir dados simulados

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

Parâmetros

data

Visio.Interfaces.PageViewData

Retornos

void

setPosition(Position)

Define a posição da página no modo de exibição.

setPosition(Position: Visio.Position): void;

Parâmetros

Position

Visio.Position

Objeto Position que especifica a nova posição da página na visualização.

Retornos

void

Comentários

[ Conjunto de API: 1.1 ]

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Visio.PageView original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Visio.Interfaces.PageViewData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Visio.Interfaces.PageViewData;

Retornos

Visio.Interfaces.PageViewData