Visio.PageView class

Representa a classe PageView.

Extends

Comentários

[ Conjunto de API: 1.1 ]

Propriedades

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

zoom

Obtenha e defina o nível de Zoom da Página. O valor pode ser entre 10 e 400 e indica a percentagem 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. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties)

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

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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Visio.PageView original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Visio.Interfaces.PageViewData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

zoom

Obtenha e defina o nível de Zoom da Página. O valor pode ser entre 10 e 400 e indica a percentagem 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

Comentários

[ Conjunto de API: 1.1 ]

getSelection()

Representa a Seleção na página.

getSelection(): Visio.Selection;

Retornos

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

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 as propriedades do objeto a carregar.

Retornos

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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas 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 que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

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

set(properties: Visio.PageView): void;

Parâmetros

properties
Visio.PageView

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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Visio.PageView original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Visio.Interfaces.PageViewData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Visio.Interfaces.PageViewData;

Retornos