Visio.PageView class
Représente la classe PageView.
- Extends
Remarques
Propriétés
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| zoom | Obtenez et définissez le niveau de zoom de la page. La valeur peut être comprise entre 10 et 400 et indique le pourcentage de zoom. |
Méthodes
| center |
Effectue un panoramique du dessin Visio pour placer la forme spécifiée au centre de l’affichage. |
| fit |
Ajuste l’objet Page à la fenêtre active. |
| get |
Spécifie la position de la page affichée. |
| get |
Représente la sélection dans la page. |
| is |
Vérifie si la forme se situe devant l’objet Page ou non. |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type. |
| set(properties) | Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant. |
| set |
Définit la position de la page dans l’affichage. |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
context
Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
context: RequestContext;Valeur de propriété
zoom
Obtenez et définissez le niveau de zoom de la page. La valeur peut être comprise entre 10 et 400 et indique le pourcentage de zoom.
zoom: number;Valeur de propriété
number
Remarques
Exemples
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));
}
});
Détails de la méthode
centerViewportOnShape(ShapeId)
Effectue un panoramique du dessin Visio pour placer la forme spécifiée au centre de l’affichage.
centerViewportOnShape(ShapeId: number): void;Paramètres
- ShapeId
-
number
Affiche ShapeId au centre.
Retours
void
Remarques
Exemples
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()
Ajuste l’objet Page à la fenêtre active.
fitToWindow(): void;Retours
void
Remarques
getPosition()
Spécifie la position de la page affichée.
getPosition(): OfficeExtension.ClientResult<Visio.Position>;Retours
Remarques
getSelection()
Représente la sélection dans la page.
getSelection(): Visio.Selection;Retours
Remarques
isShapeInViewport(Shape)
Vérifie si la forme se situe devant l’objet Page ou non.
isShapeInViewport(Shape: Visio.Shape): OfficeExtension.ClientResult<boolean>;Paramètres
- Shape
- Visio.Shape
Forme à vérifier.
Retours
OfficeExtension.ClientResult<boolean>
Remarques
load(options)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(options?: Visio.Interfaces.PageViewLoadOptions): Visio.PageView;Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
load(propertyNames)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames?: string | string[]): Visio.PageView;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.
Retours
load(propertyNamesAndPaths)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.PageView;Paramètres
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties: Interfaces.PageViewUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Visio.Interfaces.PageViewUpdateData
Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.
- options
- OfficeExtension.UpdateOptions
Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.
Retours
void
set(properties)
Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
set(properties: Visio.PageView): void;Paramètres
- properties
- Visio.PageView
Retours
void
setPosition(Position)
Définit la position de la page dans l’affichage.
setPosition(Position: Visio.Position): void;Paramètres
- Position
- Visio.Position
Spécifie la nouvelle position de la page affichée.
Retours
void
Remarques
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Visio.PageView d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Visio.Interfaces.PageViewDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Visio.Interfaces.PageViewData;