Excel.ChartLegend class
Représente la légende d’un graphique.
- 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. |
| format | Représente le format d’une légende de graphique, à savoir le format du remplissage et de la police. |
| height | Indique la hauteur, en points, de la légende sur le graphique. La valeur est |
| left | Indique la valeur à gauche, en points, de la légende sur le graphique. La valeur est |
| legend |
Représente une collection de legendEntries dans la légende. |
| overlay | Indique si la légende du graphique doit chevaucher le corps principal du graphique. |
| position | Spécifie la position de la légende sur le graphique. Pour |
| show |
Indique si la légende a une ombre sur le graphique. |
| top | Spécifie le haut d’une légende de graphique. |
| visible | Indique si la légende du graphique est visible. |
| width | Spécifie la largeur, en points, de la légende sur le graphique. La valeur est |
Méthodes
| 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 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 |
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é
format
Représente le format d’une légende de graphique, à savoir le format du remplissage et de la police.
readonly format: Excel.ChartLegendFormat;Valeur de propriété
Remarques
height
Indique la hauteur, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.
height: number;Valeur de propriété
number
Remarques
left
Indique la valeur à gauche, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.
left: number;Valeur de propriété
number
Remarques
legendEntries
Représente une collection de legendEntries dans la légende.
readonly legendEntries: Excel.ChartLegendEntryCollection;Valeur de propriété
Remarques
overlay
Indique si la légende du graphique doit chevaucher le corps principal du graphique.
overlay: boolean;Valeur de propriété
boolean
Remarques
position
Spécifie la position de la légende sur le graphique. Pour Excel.ChartLegendPosition plus de détails.
position: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom";Valeur de propriété
Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom"
Remarques
showShadow
Indique si la légende a une ombre sur le graphique.
showShadow: boolean;Valeur de propriété
boolean
Remarques
top
Spécifie le haut d’une légende de graphique.
top: number;Valeur de propriété
number
Remarques
visible
Indique si la légende du graphique est visible.
visible: boolean;Valeur de propriété
boolean
Remarques
width
Spécifie la largeur, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.
width: number;Valeur de propriété
number
Remarques
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.ChartLegendLoadOptions): Excel.ChartLegend;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[]): Excel.ChartLegend;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
Exemples
// Get the position of Chart Legend from Chart1.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
const legend = chart.legend;
legend.load('position');
await context.sync();
console.log(legend.position);
});
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.ChartLegend;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.ChartLegendUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.ChartLegendUpdateData
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.ChartLegend): void;Paramètres
- properties
- Excel.ChartLegend
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.ChartLegend est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ChartLegendDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.ChartLegendData;