Visio.ShapeView class

Paquet:

visio

Représente la classe ShapeView.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : 1.1 ]

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.
highlight	Représente la mise en surbrillance autour de la forme.

Méthodes

addOverlay(OverlayType, Content, OverlayHorizontalAlignment, OverlayVerticalAlignment, Width, Height)	Ajoute une superposition sur la forme.
addOverlay(OverlayTypeString, Content, OverlayHorizontalAlignmentString, OverlayVerticalAlignmentString, Width, Height)	Ajoute une superposition sur la forme.
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(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(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.
removeOverlay(OverlayId)	Supprime une ou toutes les superpositions de la forme.
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.
setText(Text)	L’objectif de l’API SetText est de mettre à jour le texte à l’intérieur d’une forme Visio au moment de l’exécution. Le texte mis à jour conserve les propriétés de mise en forme existantes du texte de la forme.
showOverlay(overlayId, show)	Affiche une superposition particulière sur la forme.
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.ShapeView d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Visio.Interfaces.ShapeViewDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

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é

Visio.RequestContext

highlight

Représente la mise en surbrillance autour de la forme.

highlight: Visio.Highlight;

Valeur de propriété

Visio.Highlight

Remarques

[ Ensemble d’API : 1.1 ]

Exemples

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    shape.view.highlight = { color: "#E7E7E7", width: 100 };
    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

addOverlay(OverlayType, Content, OverlayHorizontalAlignment, OverlayVerticalAlignment, Width, Height)

Ajoute une superposition sur la forme.

addOverlay(OverlayType: Visio.OverlayType, Content: string, OverlayHorizontalAlignment: Visio.OverlayHorizontalAlignment, OverlayVerticalAlignment: Visio.OverlayVerticalAlignment, Width: number, Height: number): OfficeExtension.ClientResult<number>;

Paramètres

OverlayType

Visio.OverlayType

Type de superposition. Peut être « Text », « Image » ou « Html ».

Content

string

Contenu de la superposition.

OverlayHorizontalAlignment

Visio.OverlayHorizontalAlignment

Alignement horizontal de la superposition. Peut être « Gauche », « Centre » ou « Droite ».

OverlayVerticalAlignment

Visio.OverlayVerticalAlignment

Alignement vertical de la superposition. Peut être « Top », « Middle », « Bottom ».

Width

number

Largeur de la superposition.

Height

number

Hauteur de la superposition.

Retours

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : 1.1 ]

Exemples

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    const overlayId = shape.view.addOverlay("Image", "Visio Online", "Center", "Middle", 50, 50);
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

addOverlay(OverlayTypeString, Content, OverlayHorizontalAlignmentString, OverlayVerticalAlignmentString, Width, Height)

Ajoute une superposition sur la forme.

addOverlay(OverlayTypeString: "Text" | "Image" | "Html", Content: string, OverlayHorizontalAlignmentString: "Left" | "Center" | "Right", OverlayVerticalAlignmentString: "Top" | "Middle" | "Bottom", Width: number, Height: number): OfficeExtension.ClientResult<number>;

Paramètres

OverlayTypeString

"Text" | "Image" | "Html"

Type de superposition. Peut être « Text », « Image » ou « Html ».

Content

string

Contenu de la superposition.

OverlayHorizontalAlignmentString

"Left" | "Center" | "Right"

Alignement horizontal de la superposition. Peut être « Gauche », « Centre » ou « Droite ».

OverlayVerticalAlignmentString

"Top" | "Middle" | "Bottom"

Alignement vertical de la superposition. Peut être « Top », « Middle », « Bottom ».

Width

number

Largeur de la superposition.

Height

number

Hauteur de la superposition.

Retours

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : 1.1 ]

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.ShapeViewLoadOptions): Visio.ShapeView;

Paramètres

options

Visio.Interfaces.ShapeViewLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Visio.ShapeView

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.ShapeView;

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

Visio.ShapeView

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.ShapeView;

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

Visio.ShapeView

removeOverlay(OverlayId)

Supprime une ou toutes les superpositions de la forme.

removeOverlay(OverlayId: number): void;

Paramètres

OverlayId

number

ID de la superposition. Supprime l’ID de la superposition de la forme.

Retours

void

Remarques

[ Ensemble d’API : 1.1 ]

Exemples

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    shape.view.removeOverlay(1);
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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.ShapeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties

Visio.Interfaces.ShapeViewUpdateData

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.ShapeView): void;

Paramètres

properties

Visio.ShapeView

Retours

void

setText(Text)

L’objectif de l’API SetText est de mettre à jour le texte à l’intérieur d’une forme Visio au moment de l’exécution. Le texte mis à jour conserve les propriétés de mise en forme existantes du texte de la forme.

setText(Text: string): void;

Paramètres

Text

string

Le paramètre Text est le texte mis à jour à afficher sur la forme.

Retours

void

Remarques

[ Ensemble d’API : 1.1 ]

showOverlay(overlayId, show)

Affiche une superposition particulière sur la forme.

showOverlay(overlayId: number, show: boolean): void;

Paramètres

overlayId

number

ID de superposition dans le contexte.

show

boolean

Indique s’il faut afficher la superposition.

Retours

void

Remarques

[ Ensemble d’API : 1.1 ]

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.ShapeView d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Visio.Interfaces.ShapeViewDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Visio.Interfaces.ShapeViewData;

Retours

Visio.Interfaces.ShapeViewData