Excel.ChartDataLabel class

Référence

Paquet:: excel

Représente l’étiquette de données d’un point de graphique.

Extends: OfficeExtension.ClientObject

Remarques

Propriétés

autoText	Spécifie si l’étiquette de données génère automatiquement le texte approprié en fonction du contexte.
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’étiquette de données graphique.
formula	Valeur de chaîne qui représente la formule de l’étiquette de données du graphique à l’aide de la notation de style A1.
height	Représente la hauteur, exprimée en points, de l’étiquette de données du graphique. La valeur est `null` si l’étiquette de données du graphique n’est pas visible.
horizontalAlignment	Représente l’alignement horizontal de l’étiquette de données du graphique. Pour plus d’informations, consultez `Excel.ChartTextHorizontalAlignment` . Cette propriété est valide uniquement lorsque `TextOrientation` l’étiquette de données est -90, 90 ou 180.
left	Représente la distance en points, du bord gauche de l’étiquette de données graphique au bord gauche de la zone de graphique. La valeur est `null` si l’étiquette de données du graphique n’est pas visible.
linkNumberFormat	Spécifie si le format de nombre est lié aux cellules (de sorte que le format des nombres change dans les étiquettes lorsqu’il change dans les cellules).
numberFormat	Valeur de chaîne qui représente le code de format pour l’étiquette de données.
position	Valeur qui représente la position de l’étiquette de données. Pour plus d’informations, consultez `Excel.ChartDataLabelPosition` .
separator	Chaîne représentant le séparateur utilisé pour les étiquettes de données d’un graphique.
showBubbleSize	Spécifie si la taille de la bulle d’étiquette de données est visible.
showCategoryName	Spécifie si le nom de la catégorie d’étiquette de données est visible.
showLegendKey	Spécifie si la clé de légende d’étiquette de données est visible.
showPercentage	Spécifie si le pourcentage d’étiquette de données est visible.
showSeriesName	Spécifie si le nom de la série d’étiquettes de données est visible.
showValue	Spécifie si la valeur de l’étiquette de données est visible.
text	Chaîne représentant le texte d’étiquette de données dans un graphique.
textOrientation	Représente l’angle vers lequel le texte est orienté pour l’étiquette de données du graphique. La valeur doit être un entier compris entre -90 et 90 ou l’entier 180 pour le texte orienté verticalement.
top	Représente la distance en points, du bord supérieur de l’étiquette de données graphique au bord supérieur de la zone de graphique. La valeur est `null` si l’étiquette de données du graphique n’est pas visible.
verticalAlignment	Représente l’alignement vertical de l’étiquette de données du graphique. Pour plus d’informations, consultez `Excel.ChartTextVerticalAlignment` . Cette propriété n’est valide que lorsque `TextOrientation` l’étiquette de données est 0.
width	Représente la largeur, exprimée en points, de l’étiquette de données du graphique. La valeur est `null` si l’étiquette de données du graphique 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.stringify`appelle à son tour la `toJSON` méthode de l’objet qui lui est passé.) Alors que l’objet Excel.ChartDataLabel d’origine est un objet API, la `toJSON` méthode renvoie un objet JavaScript brut (tapé en tant `Excel.Interfaces.ChartDataLabelData`que ) 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é

autoText

Spécifie si l’étiquette de données génère automatiquement le texte approprié en fonction du contexte.

autoText: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

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’étiquette de données graphique.

readonly format: Excel.ChartDataLabelFormat;

Valeur de propriété

Excel.ChartDataLabelFormat

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

formula

Valeur de chaîne qui représente la formule de l’étiquette de données du graphique à l’aide de la notation de style A1.

formula: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

height

Représente la hauteur, exprimée en points, de l’étiquette de données du graphique. La valeur est null si l’étiquette de données du graphique n’est pas visible.

readonly height: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

horizontalAlignment

Représente l’alignement horizontal de l’étiquette de données du graphique. Pour plus d’informations, consultez Excel.ChartTextHorizontalAlignment . Cette propriété est valide uniquement lorsque TextOrientation l’étiquette de données est -90, 90 ou 180.

horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

left

Représente la distance en points, du bord gauche de l’étiquette de données graphique au bord gauche de la zone de graphique. La valeur est null si l’étiquette de données du graphique n’est pas visible.

left: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

linkNumberFormat

Spécifie si le format de nombre est lié aux cellules (de sorte que le format des nombres change dans les étiquettes lorsqu’il change dans les cellules).

linkNumberFormat: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

numberFormat

Valeur de chaîne qui représente le code de format pour l’étiquette de données.

numberFormat: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

position

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

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

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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

[ Ensemble d’API : ExcelApi 1.7 ]

showBubbleSize

Spécifie si la taille de la bulle d’étiquette de données est visible.

showBubbleSize: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

showCategoryName

Spécifie si le nom de la catégorie d’étiquette de données est visible.

showCategoryName: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

showLegendKey

Spécifie si la clé de légende d’étiquette de données est visible.

showLegendKey: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

showPercentage

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

showPercentage: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

showSeriesName

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

showSeriesName: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

showValue

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

showValue: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

text

Chaîne représentant le texte d’étiquette de données dans un graphique.

text: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

textOrientation

Représente l’angle vers lequel le texte est orienté pour l’étiquette de données du graphique. La valeur doit être un entier compris entre -90 et 90 ou l’entier 180 pour le texte orienté verticalement.

textOrientation: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

top

Représente la distance en points, du bord supérieur de l’étiquette de données graphique au bord supérieur de la zone de graphique. La valeur est null si l’étiquette de données du graphique n’est pas visible.

top: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

verticalAlignment

Représente l’alignement vertical de l’étiquette de données du graphique. Pour plus d’informations, consultez Excel.ChartTextVerticalAlignment . Cette propriété n’est valide que lorsque TextOrientation l’étiquette de données est 0.

verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

width

Représente la largeur, exprimée en points, de l’étiquette de données du graphique. La valeur est null si l’étiquette de données du graphique n’est pas visible.

readonly width: number;

Valeur de propriété

number

Remarques

[ Ensemble 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.ChartDataLabelLoadOptions): Excel.ChartDataLabel;

Paramètres

options: Excel.Interfaces.ChartDataLabelLoadOptions

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

Retours

Excel.ChartDataLabel

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

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.ChartDataLabel

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

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.ChartDataLabel

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

Paramètres

properties: Excel.Interfaces.ChartDataLabelUpdateData

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.ChartDataLabel): void;

Paramètres

properties: Excel.ChartDataLabel

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 Excel.ChartDataLabel d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.ChartDataLabelDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.ChartDataLabelData;

Retours

Excel.Interfaces.ChartDataLabelData