Excel.ChartLegendEntry class

Représente l’entrée de légende dans legendEntryCollection.

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.

height

Indique la hauteur de l’entrée de légende sur la légende du graphique.

index

Spécifie l’index de l’entrée de légende dans la légende du graphique.

left

Spécifie la valeur à gauche d’une entrée de légende de graphique.

top

Spécifie le haut d’une entrée de légende de graphique.

visible

Représente la visibilité d’une entrée de légende de graphique.

width

Représente la largeur de l’entrée de légende sur la légende du graphique.

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.

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit 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.

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 Excel.ChartLegendEntry est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ChartLegendEntryDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

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é

height

Indique la hauteur de l’entrée de légende sur la légende du graphique.

readonly height: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.8

index

Spécifie l’index de l’entrée de légende dans la légende du graphique.

readonly index: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.8

left

Spécifie la valeur à gauche d’une entrée de légende de graphique.

readonly left: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.8

top

Spécifie le haut d’une entrée de légende de graphique.

readonly top: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.8

visible

Représente la visibilité d’une entrée de légende de graphique.

visible: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.7

width

Représente la largeur de l’entrée de légende sur la légende du graphique.

readonly width: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.8

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?: Excel.Interfaces.ChartLegendEntryLoadOptions): Excel.ChartLegendEntry;

Paramètres

options
Excel.Interfaces.ChartLegendEntryLoadOptions

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[]): Excel.ChartLegendEntry;

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?: {
            select?: string;
            expand?: string;
        }): Excel.ChartLegendEntry;

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 transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.ChartLegendEntryUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.ChartLegendEntryUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux 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 de propriétés 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: Excel.ChartLegendEntry): void;

Paramètres

Retours

void

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 Excel.ChartLegendEntry est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ChartLegendEntryDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.ChartLegendEntryData;

Retours