Partager via

Excel.ChartLegend class

  • Référence
Paquet:
excel

Représente la légende d’un graphique.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 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

Représente le format d’une légende de graphique, à savoir le format du remplissage et de la police.
height

Spécifie la hauteur, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.
left

Spécifie la valeur de gauche, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.
legendEntries

Représente une collection de legendEntries dans la légende.
overlay

Spécifie si la légende du graphique doit chevaucher le corps main du graphique.
position

Spécifie la position de la légende sur le graphique. Pour plus d’informations, consultez Excel.ChartLegendPosition .
showShadow

Spécifie si la légende comporte une ombre sur le graphique.
top

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

Spécifie 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 null si la légende n’est pas visible.

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 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.
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 d’origine Excel.ChartLegend est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.ChartLegendDataque ) 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é

Excel.RequestContext

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é

Excel.ChartLegendFormat

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

height

Spécifie 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

[ Ensemble d’API : ExcelApi 1.7 ]

left

Spécifie la valeur de 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

[ Ensemble d’API : ExcelApi 1.7 ]

legendEntries

Représente une collection de legendEntries dans la légende.

readonly legendEntries: Excel.ChartLegendEntryCollection;

Valeur de propriété

Excel.ChartLegendEntryCollection

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

overlay

Spécifie si la légende du graphique doit chevaucher le corps main du graphique.

overlay: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

position

Spécifie la position de la légende sur le graphique. Pour plus d’informations, consultez Excel.ChartLegendPosition .

position: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom";

Valeur de propriété

Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom"

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

showShadow

Spécifie si la légende comporte une ombre sur le graphique.

showShadow: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

top

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

top: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

visible

Spécifie si la légende du graphique est visible.

visible: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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

[ Ensemble d’API : ExcelApi 1.7 ]

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

options
Excel.Interfaces.ChartLegendLoadOptions

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

Retours

Excel.ChartLegend

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 qui spécifient les propriétés à charger.

Retours

Excel.ChartLegend

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

Excel.ChartLegend

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

Paramètres

properties
Excel.Interfaces.ChartLegendUpdateData

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: 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.stringifyappelle à son tour 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 brut (typé en tant Excel.Interfaces.ChartLegendDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.ChartLegendData;

Retours

Excel.Interfaces.ChartLegendData