Visio.ShapeDataItemCollection class
Représente la collection d’éléments de données pour une forme donnée.
- Extends
Propriétés
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
| get |
Obtient le nombre d’éléments de données de forme. |
| get |
Obtient l’élément de données de forme à l’aide de son nom. |
| 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 |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;
Valeur de propriété
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Visio.ShapeDataItem[];
Valeur de propriété
Détails de la méthode
getCount()
Obtient le nombre d’éléments de données de forme.
getCount(): OfficeExtension.ClientResult<number>;
Retours
OfficeExtension.ClientResult<number>
Remarques
getItem(key)
Obtient l’élément de données de forme à l’aide de son nom.
getItem(key: string): Visio.ShapeDataItem;
Paramètres
- key
-
string
La clé est le nom de l’élément de données de forme à récupérer.
Retours
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.ShapeDataItemCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.ShapeDataItemCollection;
Paramètres
- options
-
Visio.Interfaces.ShapeDataItemCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions
Fournit des options pour les propriétés de l’objet à charger.
Retours
Exemples
Visio.run(session, function (ctx) {
const activePage = ctx.document.getActivePage();
const shape = activePage.shapes.getItem(0);
const shapeDataItems = shape.shapeDataItems;
shapeDataItems.load(["label", "value"]);
return ctx.sync().then(function() {
for (let i = 0; i < shapeDataItems.items.length; i++) {
console.log(shapeDataItems.items[i].label);
console.log(shapeDataItems.items[i].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.ShapeDataItemCollection;
Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes spécifiant 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?: OfficeExtension.LoadOption): Visio.ShapeDataItemCollection;
Paramètres
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Visio.ShapeDataItemCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Visio.Interfaces.ShapeDataItemCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.
toJSON(): Visio.Interfaces.ShapeDataItemCollectionData;