Excel.ChartDataLabel class
Représente l’étiquette de données d’un point de graphique.
- Extends
Remarques
Utilisateur
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml
// This function styles substrings within data label text using font formatting.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem(sheetName);
const chart = sheet.charts.getItemAt(0);
await context.sync();
const series = chart.series.getItemAt(0);
series.load("points");
await context.sync();
series.points.load("items");
await context.sync();
// Style a substring in the first data label.
let searchString = "sports";
let dataLabel = series.points.getItemAt(dataLabelInfo[0].index).dataLabel.load("text");
await context.sync();
let substringStart = dataLabel.text.indexOf(searchString);
let subLabel = dataLabel.getSubstring(substringStart, searchString.length);
subLabel.font.size = 13;
subLabel.font.bold = true;
// Style a substring in the second data label.
searchString = "'Titanic'";
dataLabel = series.points.getItemAt(dataLabelInfo[1].index).dataLabel.load("text");
await context.sync();
substringStart = dataLabel.text.indexOf(searchString);
subLabel = dataLabel.getSubstring(substringStart, searchString.length);
subLabel.font.name = "Calibri";
subLabel.font.size = 13;
subLabel.font.italic = true;
subLabel.font.color = "blue";
await context.sync();
});
Propriétés
| auto |
Indique si l’étiquette de données génère 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 | 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. |
| geometric |
Spécifie le type de forme géométrique de l’étiquette de données. Pour plus d’informations, consultez l’article |
| height | Représente la hauteur, exprimée en points, de l’étiquette de données du graphique. Indique |
| horizontal |
Représente l’alignement horizontal de l’étiquette de données du graphique. Pour |
| 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. Indique |
| link |
Spécifie si le format de nombre est lié aux cellules (de sorte que le format de nombre change dans les étiquettes lorsqu’il change dans les cellules). |
| number |
Spécifie le code de format de l’étiquette de données. |
| position | Valeur qui représente la position de l’étiquette de données. Pour |
| separator | Chaîne représentant le séparateur utilisé pour les étiquettes de données d’un graphique. |
| show |
Indique si l’étiquette de données s’affiche sous forme de légende avec l’ancre de queue attachée au point de données. Si |
| show |
Indique si la taille de la bulle de l’étiquette de données est visible. |
| show |
Indique si le nom de la catégorie de l’étiquette de données est visible. |
| show |
Indique si la légende de l’étiquette de données est visible. |
| show |
Indique si le pourcentage d’étiquette de données est visible. |
| show |
Indique si le nom de la série d’étiquettes de données est visible. |
| show |
Indique 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. |
| text |
Représente l’angle d’orientation du texte pour l’étiquette de données de 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. Indique |
| vertical |
Représente l’alignement vertical de l’étiquette de données du graphique. Pour |
| width | Représente la largeur, exprimée en points, de l’étiquette de données du graphique. Indique |
Méthodes
| get |
Renvoie une sous-chaîne de l’étiquette de données. Le caractère de saut de ligne '\n' compte pour un caractère. |
| get |
Renvoie l’ancre de queue de l’étiquette de données qui s’affiche sous la forme d’une légende rémanente. |
| 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. |
| set |
Définit la hauteur de l’étiquette de données en points. |
| set |
Définit la largeur de l’étiquette de données en points. |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
autoText
Indique si l’étiquette de données génère automatiquement un texte approprié en fonction du contexte.
autoText: boolean;Valeur de propriété
boolean
Remarques
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’étiquette de données graphique.
readonly format: Excel.ChartDataLabelFormat;Valeur de propriété
Remarques
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
geometricShapeType
Spécifie le type de forme géométrique de l’étiquette de données. Pour plus d’informations, consultez l’article Excel.GeometricShapeType.
null Valeur si l’étiquette de données n’est pas une forme géométrique.
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
height
Représente la hauteur, exprimée en points, de l’étiquette de données du graphique. Indique null si l’étiquette des données du graphique n’est pas visible.
readonly height: number;Valeur de propriété
number
Remarques
horizontalAlignment
Représente l’alignement horizontal de l’étiquette de données du graphique. Pour Excel.ChartTextHorizontalAlignment plus de détails. 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é
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
Remarques
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. Indique null si l’étiquette des données du graphique n’est pas visible.
left: number;Valeur de propriété
number
Remarques
linkNumberFormat
Spécifie si le format de nombre est lié aux cellules (de sorte que le format de nombre change dans les étiquettes lorsqu’il change dans les cellules).
linkNumberFormat: boolean;Valeur de propriété
boolean
Remarques
numberFormat
Spécifie le code de format de l’étiquette de données.
numberFormat: string;Valeur de propriété
string
Remarques
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
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
showAsStickyCallout
Indique si l’étiquette de données s’affiche 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
showBubbleSize
Indique si la taille de la bulle de l’étiquette de données est visible.
showBubbleSize: boolean;Valeur de propriété
boolean
Remarques
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
showLegendKey
Indique si la légende de l’étiquette de données est visible.
showLegendKey: boolean;Valeur de propriété
boolean
Remarques
showPercentage
Indique si le pourcentage d’étiquette de données est visible.
showPercentage: boolean;Valeur de propriété
boolean
Remarques
showSeriesName
Indique si le nom de la série d’étiquettes de données est visible.
showSeriesName: boolean;Valeur de propriété
boolean
Remarques
showValue
Indique si la valeur de l’étiquette de données est visible.
showValue: boolean;Valeur de propriété
boolean
Remarques
text
Chaîne représentant le texte d’étiquette de données dans un graphique.
text: string;Valeur de propriété
string
Remarques
textOrientation
Représente l’angle d’orientation du texte pour l’étiquette de données de 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
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. Indique null si l’étiquette des données du graphique n’est pas visible.
top: number;Valeur de propriété
number
Remarques
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 0.
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";Valeur de propriété
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
Remarques
width
Représente la largeur, exprimée en points, de l’étiquette de données du graphique. Indique null si l’étiquette des données du graphique n’est pas visible.
readonly width: number;Valeur de propriété
number
Remarques
Détails de la méthode
getSubstring(start, length)
Renvoie une sous-chaîne de l’étiquette de données. Le caractère de saut de ligne '\n' compte pour un caractère.
getSubstring(start: number, length?: number): Excel.ChartFormatString;Paramètres
- start
-
number
Position du caractère de départ en base zéro d’une sous-chaîne dans l’étiquette de données.
- length
-
number
Facultatif. Nombre de caractères dans la sous-chaîne. Si la longueur est omise, tous les caractères du début à la fin de l’étiquette de données sont récupérés.
Retours
Remarques
getTailAnchor()
Renvoie l’ancre de queue de l’étiquette de données qui s’affiche sous la forme d’une légende rémanente.
getTailAnchor(): Excel.ChartDataLabelAnchor;Retours
Remarques
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
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.ChartDataLabel;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
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
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.ChartDataLabelUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.ChartDataLabelUpdateData
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.ChartDataLabel): void;Paramètres
- properties
- Excel.ChartDataLabel
Retours
void
setHeight(height)
Définit la hauteur de l’étiquette de données en points.
setHeight(height: number): void;Paramètres
- height
-
number
Hauteur de l’étiquette de données, en points.
Retours
void
Remarques
setWidth(width)
Définit la largeur de l’étiquette de données en points.
setWidth(width: number): void;Paramètres
- width
-
number
Largeur de l’étiquette de données en points.
Retours
void
Remarques
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.ChartDataLabel est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ChartDataLabelDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.ChartDataLabelData;