Excel.ChartDataLabels class

Représente une collection de toutes les étiquettes de données associées à un point de 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

Spécifie le format des étiquettes de données de graphique, qui inclut la mise en forme du remplissage et de la police.

position

Valeur qui représente la position de l’étiquette de données. Pour Excel.ChartDataLabelPosition plus de détails.

separator

Chaîne représentant le séparateur utilisé pour les étiquettes de données d’un graphique.

showBubbleSize

Indique si la taille de la bulle de l’étiquette de données est visible.

showCategoryName

Indique si le nom de la catégorie de l’étiquette de données est visible.

showLegendKey

Indique si la légende de l’étiquette de données est visible.

showPercentage

Indique si le pourcentage d’étiquette de données est visible.

showSeriesName

Indique si le nom de la série d’étiquettes de données est visible.

showValue

Indique si la valeur de l’étiquette de données est 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 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.ChartDataLabels est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ChartDataLabelsDataqui 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é

format

Spécifie le format des étiquettes de données de graphique, qui inclut la mise en forme du remplissage et de la police.

readonly format: Excel.ChartDataLabelFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

position

Valeur qui représente la position de l’étiquette de données. Pour Excel.ChartDataLabelPosition plus de détails.

position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";

Valeur de propriété

Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"

Remarques

Jeu d’API : ExcelApi 1.1

separator

Chaîne représentant le séparateur utilisé pour les étiquettes de données d’un graphique.

separator: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.1

showBubbleSize

Indique si la taille de la bulle de l’étiquette de données est visible.

showBubbleSize: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

showCategoryName

Indique si le nom de la catégorie de l’étiquette de données est visible.

showCategoryName: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

showLegendKey

Indique si la légende de l’étiquette de données est visible.

showLegendKey: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

showPercentage

Indique si le pourcentage d’étiquette de données est visible.

showPercentage: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

showSeriesName

Indique si le nom de la série d’étiquettes de données est visible.

showSeriesName: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

showValue

Indique si la valeur de l’étiquette de données est visible.

showValue: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 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?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;

Paramètres

options
Excel.Interfaces.ChartDataLabelsLoadOptions

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

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

// Show the series name in data labels and set the position of the data labels to "top".
await Excel.run(async (context) => {
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
    chart.dataLabels.showValue = true;
    chart.dataLabels.position = Excel.ChartDataLabelPosition.top;
    chart.dataLabels.showSeriesName = true;
    await context.sync();

    console.log("Data labels shown");
});

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

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

Paramètres

properties
Excel.Interfaces.ChartDataLabelsUpdateData

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

toJSON(): Excel.Interfaces.ChartDataLabelsData;

Retours