Visio.ShapeDataItem class

Paquet:

visio

Représente l’objet ShapeDataItem.

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.
format	Chaîne spécifiant le format de l’élément de données de forme.
formattedValue	Chaîne spécifiant la valeur formatée de l’élément de données de forme.
label	Chaîne qui spécifie l’étiquette de l’élément de données de forme.
value	Chaîne qui spécifie la valeur de l’élément de données de forme.

Méthodes

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.
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.ShapeDataItem d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Visio.Interfaces.ShapeDataItemDataque ) 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

format

Chaîne spécifiant le format de l’élément de données de forme.

readonly format: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : 1.1 ]

formattedValue

Chaîne spécifiant la valeur formatée de l’élément de données de forme.

readonly formattedValue: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : 1.1 ]

label

Chaîne qui spécifie l’étiquette de l’élément de données de forme.

readonly label: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : 1.1 ]

value

Chaîne qui spécifie la valeur de l’élément de données de forme.

readonly value: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : 1.1 ]

Détails de la méthode

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.ShapeDataItemLoadOptions): Visio.ShapeDataItem;

Paramètres

options

Visio.Interfaces.ShapeDataItemLoadOptions

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

Retours

Visio.ShapeDataItem

Exemples

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    const shapeDataItem = shape.shapeDataItems.getItem(0);
    shapeDataItem.load(["label", "value"]);
        return ctx.sync().then(function() {
            console.log(shapeDataItem.label);
            console.log(shapeDataItem.value);
        });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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

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.ShapeDataItem

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

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.ShapeDataItem

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

toJSON(): Visio.Interfaces.ShapeDataItemData;

Retours

Visio.Interfaces.ShapeDataItemData