Visio.PageView class

Paket:

visio

Stellt die PageView-Klasse dar.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: 1.1 ]

Eigenschaften

context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
zoom	Rufen Sie die Zoomstufe der Seite ab, und legen Sie sie fest. Der Wert kann zwischen 10 und 400 sein und gibt den Prozentsatz des Zooms an.

Methoden

centerViewportOnShape(ShapeId)	Schwenkt die Visio-Zeichnung so, dass das angegebene Shape in der Mitte der Ansicht platziert wird.
fitToWindow()	Seite wird an das aktuelle Fenster angepasst.
getPosition()	Gibt das Position-Objekt zurück, das die Position der Seite in der Ansicht angibt.
getSelection()	Stellt die Auswahl auf der Seite dar.
isShapeInViewport(Shape)	Zum Überprüfen, ob sich das Shape in der Ansicht der Seite befindet oder nicht.
load(options)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
set(properties, options)	Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties)	Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
setMockData(data)	Festlegen von Modelldaten
setPosition(Position)	Legt die Position der Seite in der Ansicht fest.
toJSON()	Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Visio.PageView-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Visio.Interfaces.PageViewData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Visio.RequestContext

zoom

Rufen Sie die Zoomstufe der Seite ab, und legen Sie sie fest. Der Wert kann zwischen 10 und 400 sein und gibt den Prozentsatz des Zooms an.

zoom: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: 1.1 ]

Beispiele

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

Details zur Methode

centerViewportOnShape(ShapeId)

Schwenkt die Visio-Zeichnung so, dass das angegebene Shape in der Mitte der Ansicht platziert wird.

centerViewportOnShape(ShapeId: number): void;

Parameter

ShapeId

number

ShapeId, die in der Mitte angezeigt werden soll.

Gibt zurück

void

Hinweise

[ API-Satz: 1.1 ]

Beispiele

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

Seite wird an das aktuelle Fenster angepasst.

fitToWindow(): void;

Gibt zurück

void

Hinweise

[ API-Satz: 1.1 ]

getPosition()

Gibt das Position-Objekt zurück, das die Position der Seite in der Ansicht angibt.

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

Gibt zurück

OfficeExtension.ClientResult<Visio.Position>

Hinweise

[ API-Satz: 1.1 ]

getSelection()

Stellt die Auswahl auf der Seite dar.

getSelection(): Visio.Selection;

Gibt zurück

Visio.Selection

Hinweise

[ API-Satz: 1.1 ]

isShapeInViewport(Shape)

Zum Überprüfen, ob sich das Shape in der Ansicht der Seite befindet oder nicht.

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

Parameter

Shape

Visio.Shape

Zu überprüfendes Shape.

Gibt zurück

OfficeExtension.ClientResult<boolean>

Hinweise

[ API-Satz: 1.1 ]

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

options

Visio.Interfaces.PageViewLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Visio.PageView

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Visio.PageView

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

propertyNamesAndPaths

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

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Visio.PageView

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

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

Parameter

properties

Visio.Interfaces.PageViewUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options

OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Visio.PageView): void;

Parameter

properties

Visio.PageView

Gibt zurück

void

setMockData(data)

Festlegen von Modelldaten

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

Parameter

data

Visio.Interfaces.PageViewData

Gibt zurück

void

setPosition(Position)

Legt die Position der Seite in der Ansicht fest.

setPosition(Position: Visio.Position): void;

Parameter

Position

Visio.Position

Position-Objekt, das die neue Position der Seite in der Ansicht angibt.

Gibt zurück

void

Hinweise

[ API-Satz: 1.1 ]

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Visio.PageView-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Visio.Interfaces.PageViewData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Visio.Interfaces.PageViewData;

Gibt zurück

Visio.Interfaces.PageViewData