Visio.PageView class
Stellt die PageView-Klasse dar.
- Extends
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| zoom | Abrufen und Festlegen des Zoomfaktors von Page. Der Wert kann zwischen 10 und 400 liegen und gibt den Prozentsatz des Zooms an. |
Methoden
| center |
Schwenkt die Visio-Zeichnung so, dass das angegebene Shape in der Mitte der Ansicht platziert wird. |
| fit |
Seite wird an das aktuelle Fenster angepasst. |
| get |
Gibt das Position-Objekt zurück, das die Position der Seite in der Ansicht angibt. |
| get |
Stellt die Auswahl auf der Seite dar. |
| is |
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 " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| 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. |
| set |
Legt die Position der Seite in der Ansicht fest. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
zoom
Abrufen und Festlegen des Zoomfaktors von Page. Der Wert kann zwischen 10 und 400 liegen und gibt den Prozentsatz des Zooms an.
zoom: number;Eigenschaftswert
number
Hinweise
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
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
getPosition()
Gibt das Position-Objekt zurück, das die Position der Seite in der Ansicht angibt.
getPosition(): OfficeExtension.ClientResult<Visio.Position>;Gibt zurück
Hinweise
getSelection()
Stellt die Auswahl auf der Seite dar.
getSelection(): Visio.Selection;Gibt zurück
Hinweise
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
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
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
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
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 Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
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
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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
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
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 sie übergeben wird.) Während das ursprüngliche Visio.PageView-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Visio.Interfaces.PageViewDatatypisiert ) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Visio.Interfaces.PageViewData;