Excel.ChartDataLabels class

Représente une collection de toutes les étiquettes de données associées à un point de graphique.

Extends

Propriétés

autoText

Spécifie si les étiquettes de données génèrent automatiquement un texte approprié en fonction du contexte.

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.

geometricShapeType

Spécifie le type de forme géométrique des étiquettes de données. Pour plus d’informations, consultez l’article Excel.GeometricShapeType. Valeur si null les étiquettes de données ne sont pas des formes géométriques.

horizontalAlignment

Spécifie l’alignement horizontal de l’étiquette de données de graphique. Pour Excel.ChartTextHorizontalAlignment plus de détails. Cette propriété est valide uniquement lorsque l’étiquette TextOrientation de données est 0.

leaderLines

Obtient un objet qui représente les lignes de repère des étiquettes de données.

linkNumberFormat

Spécifie si le format de nombre est lié aux cellules. Si true, le format de nombre change dans les étiquettes lorsqu’il change dans les cellules.

numberFormat

Spécifie le code de format des étiquettes de données.

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.

showAsStickyCallout

Indique si les étiquettes de données sont affichées sous forme de légende avec l’ancre de queue attachée au point de données. Si true, la légende correspond à l’une des valeurs suivantes : « AccentCallout1 », « AccentCallout2 », « BorderCallout1 », « BorderCallout2 », « WedgeRectCallout », « WedgeRRectCallout » ou « WedgeEllipseCallout ». Pour plus d’informations, consultez GeometricShapeType .

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.

showLeaderLines

Indique si des lignes de repère sont affichées pour les étiquettes de données. true si des lignes de ligne de repère sont affichées ; sinon, false.

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.

textOrientation

Représente l’angle d’orientation du texte pour les étiquettes de données. La valeur doit être un entier compris entre -90 et 90 ou l’entier 180 pour le texte orienté verticalement.

verticalAlignment

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

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é

autoText

Spécifie si les étiquettes de données génèrent automatiquement un texte approprié en fonction du contexte.

autoText: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.8

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

geometricShapeType

Spécifie le type de forme géométrique des étiquettes de données. Pour plus d’informations, consultez l’article Excel.GeometricShapeType. Valeur si null les étiquettes de données ne sont pas des formes géométriques.

geometricShapeType: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";

Valeur de propriété

Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"

Remarques

Jeu d’API : ExcelApi 1.19

horizontalAlignment

Spécifie l’alignement horizontal de l’étiquette de données de graphique. Pour Excel.ChartTextHorizontalAlignment plus de détails. Cette propriété est valide uniquement lorsque l’étiquette TextOrientation de données est 0.

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

Valeur de propriété

Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"

Remarques

Jeu d’API : ExcelApi 1.8

leaderLines

Obtient un objet qui représente les lignes de repère des étiquettes de données.

readonly leaderLines: Excel.ChartLeaderLines;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.19

linkNumberFormat

Spécifie si le format de nombre est lié aux cellules. Si true, le format de nombre change dans les étiquettes lorsqu’il change dans les cellules.

linkNumberFormat: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

numberFormat

Spécifie le code de format des étiquettes de données.

numberFormat: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.8

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

showAsStickyCallout

Indique si les étiquettes de données sont affichées sous forme de légende avec l’ancre de queue attachée au point de données. Si true, la légende correspond à l’une des valeurs suivantes : « AccentCallout1 », « AccentCallout2 », « BorderCallout1 », « BorderCallout2 », « WedgeRectCallout », « WedgeRRectCallout » ou « WedgeEllipseCallout ». Pour plus d’informations, consultez GeometricShapeType .

readonly showAsStickyCallout: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.19

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

showLeaderLines

Indique si des lignes de repère sont affichées pour les étiquettes de données. true si des lignes de ligne de repère sont affichées ; sinon, false.

showLeaderLines: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.19

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

textOrientation

Représente l’angle d’orientation du texte pour les étiquettes de données. 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

Jeu d’API : ExcelApi 1.8

verticalAlignment

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

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

Valeur de propriété

Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"

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