ExcelScript.ChartDataLabels interface

Colis:

ExcelScript

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

Remarques

Exemples

/**
 * This sample configures data labels on a chart series.
 * This assumes the active worksheet has a pie chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Configure the data labels.
  const series = chart.getSeries()[0];
  const dataLabels = series.getDataLabels();
  dataLabels.setShowPercentage(true);
  dataLabels.setShowSeriesName(false);
  dataLabels.setShowCategoryName(false);
  dataLabels.setShowValue(false);
}

Méthode

getAutoText()	Spécifie si les étiquettes de données génèrent automatiquement le texte approprié en fonction du contexte.
getFormat()	Spécifie le format des étiquettes de données de graphique, qui inclut la mise en forme de remplissage et de police.
getGeometricShapeType()	Spécifie le type de forme géométrique des étiquettes de données. Pour plus d’informations, consultez l’article ExcelScript.GeometricShapeType. La valeur est null si les étiquettes de données ne sont pas des formes géométriques.
getHorizontalAlignment()	Spécifie l’alignement horizontal de l’étiquette de données du graphique. Pour plus d’informations, consultez ExcelScript.ChartTextHorizontalAlignment . Cette propriété est valide uniquement lorsque le de l’étiquette TextOrientation de données est 0.
getLeaderLines()	Obtient un objet qui représente les lignes d’étiquettes de données.
getLinkNumberFormat()	Spécifie si le format de nombre est lié aux cellules. Si truela valeur est , le format numérique change dans les étiquettes lorsqu’il change dans les cellules.
getNumberFormat()	Spécifie le code de format des étiquettes de données.
getPosition()	Valeur qui représente la position de l’étiquette de données. Pour plus d’informations, consultez ExcelScript.ChartDataLabelPosition .
getSeparator()	Chaîne représentant le séparateur utilisé pour les étiquettes de données d’un graphique.
getShowAsStickyCallout()	Spécifie si les étiquettes de données sont affichées sous forme de légende avec l’ancre de fin attachée au point de données. Si truela valeur est , la légende est l’une des valeurs suivantes : « AccentCallout1 », « AccentCallout2 », « BorderCallout1 », « BorderCallout2 », « WedgeRectCallout », « WedgeRRectCallout » ou « WedgeEllipseCallout ».
getShowBubbleSize()	Spécifie si la taille de la bulle d’étiquette de données est visible.
getShowCategoryName()	Spécifie si le nom de la catégorie d’étiquette de données est visible.
getShowLeaderLines()	Spécifie si les lignes d’leader sont affichées pour les étiquettes de données. true si des lignes d’leader sont affichées ; sinon, false.
getShowLegendKey()	Spécifie si la clé de légende d’étiquette de données est visible.
getShowPercentage()	Spécifie si le pourcentage d’étiquette de données est visible.
getShowSeriesName()	Spécifie si le nom de la série d’étiquettes de données est visible.
getShowValue()	Spécifie si la valeur de l’étiquette de données est visible.
getTextOrientation()	Représente l’angle auquel le texte est orienté 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.
getVerticalAlignment()	Représente l’alignement vertical de l’étiquette de données du graphique. Pour plus d’informations, consultez ExcelScript.ChartTextVerticalAlignment . Cette propriété est valide uniquement lorsque TextOrientation l’étiquette de données est -90, 90 ou 180.
setAutoText(autoText)	Spécifie si les étiquettes de données génèrent automatiquement le texte approprié en fonction du contexte.
setGeometricShapeType(geometricShapeType)	Spécifie le type de forme géométrique des étiquettes de données. Pour plus d’informations, consultez l’article ExcelScript.GeometricShapeType. La valeur est null si les étiquettes de données ne sont pas des formes géométriques.
setHorizontalAlignment(horizontalAlignment)	Spécifie l’alignement horizontal de l’étiquette de données du graphique. Pour plus d’informations, consultez ExcelScript.ChartTextHorizontalAlignment . Cette propriété est valide uniquement lorsque le de l’étiquette TextOrientation de données est 0.
setLinkNumberFormat(linkNumberFormat)	Spécifie si le format de nombre est lié aux cellules. Si truela valeur est , le format numérique change dans les étiquettes lorsqu’il change dans les cellules.
setNumberFormat(numberFormat)	Spécifie le code de format des étiquettes de données.
setPosition(position)	Valeur qui représente la position de l’étiquette de données. Pour plus d’informations, consultez ExcelScript.ChartDataLabelPosition .
setSeparator(separator)	Chaîne représentant le séparateur utilisé pour les étiquettes de données d’un graphique.
setShowBubbleSize(showBubbleSize)	Spécifie si la taille de la bulle d’étiquette de données est visible.
setShowCategoryName(showCategoryName)	Spécifie si le nom de la catégorie d’étiquette de données est visible.
setShowLeaderLines(showLeaderLines)	Spécifie si les lignes d’leader sont affichées pour les étiquettes de données. true si des lignes d’leader sont affichées ; sinon, false.
setShowLegendKey(showLegendKey)	Spécifie si la clé de légende d’étiquette de données est visible.
setShowPercentage(showPercentage)	Spécifie si le pourcentage d’étiquette de données est visible.
setShowSeriesName(showSeriesName)	Spécifie si le nom de la série d’étiquettes de données est visible.
setShowValue(showValue)	Spécifie si la valeur de l’étiquette de données est visible.
setTextOrientation(textOrientation)	Représente l’angle auquel le texte est orienté 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.
setVerticalAlignment(verticalAlignment)	Représente l’alignement vertical de l’étiquette de données du graphique. Pour plus d’informations, consultez ExcelScript.ChartTextVerticalAlignment . Cette propriété est valide uniquement lorsque TextOrientation l’étiquette de données est -90, 90 ou 180.

Détails de la méthode

getAutoText()

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

getAutoText(): boolean;

Retourne

boolean

getFormat()

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

getFormat(): ChartDataLabelFormat;

Retourne

ExcelScript.ChartDataLabelFormat

getGeometricShapeType()

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

getGeometricShapeType(): GeometricShapeType;

Retourne

ExcelScript.GeometricShapeType

getHorizontalAlignment()

Spécifie l’alignement horizontal de l’étiquette de données du graphique. Pour plus d’informations, consultez ExcelScript.ChartTextHorizontalAlignment . Cette propriété est valide uniquement lorsque le de l’étiquette TextOrientation de données est 0.

getHorizontalAlignment(): ChartTextHorizontalAlignment;

Retourne

ExcelScript.ChartTextHorizontalAlignment

getLeaderLines()

Obtient un objet qui représente les lignes d’étiquettes de données.

getLeaderLines(): ChartLeaderLines;

Retourne

ExcelScript.ChartLeaderLines

getLinkNumberFormat()

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

getLinkNumberFormat(): boolean;

Retourne

boolean

getNumberFormat()

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

getNumberFormat(): string;

Retourne

string

getPosition()

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

getPosition(): ChartDataLabelPosition;

Retourne

ExcelScript.ChartDataLabelPosition

getSeparator()

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

getSeparator(): string;

Retourne

string

getShowAsStickyCallout()

Spécifie si les étiquettes de données sont affichées sous forme de légende avec l’ancre de fin attachée au point de données. Si truela valeur est , la légende est l’une des valeurs suivantes : « AccentCallout1 », « AccentCallout2 », « BorderCallout1 », « BorderCallout2 », « WedgeRectCallout », « WedgeRRectCallout » ou « WedgeEllipseCallout ».

getShowAsStickyCallout(): boolean;

Retourne

boolean

getShowBubbleSize()

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

getShowBubbleSize(): boolean;

Retourne

boolean

getShowCategoryName()

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

getShowCategoryName(): boolean;

Retourne

boolean

getShowLeaderLines()

Spécifie si les lignes d’leader sont affichées pour les étiquettes de données. true si des lignes d’leader sont affichées ; sinon, false.

getShowLeaderLines(): boolean;

Retourne

boolean

getShowLegendKey()

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

getShowLegendKey(): boolean;

Retourne

boolean

getShowPercentage()

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

getShowPercentage(): boolean;

Retourne

boolean

getShowSeriesName()

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

getShowSeriesName(): boolean;

Retourne

boolean

getShowValue()

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

getShowValue(): boolean;

Retourne

boolean

getTextOrientation()

Représente l’angle auquel le texte est orienté 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.

getTextOrientation(): number;

Retourne

number

getVerticalAlignment()

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

getVerticalAlignment(): ChartTextVerticalAlignment;

Retourne

ExcelScript.ChartTextVerticalAlignment

setAutoText(autoText)

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

setAutoText(autoText: boolean): void;

Paramètres

autoText

boolean

Retourne

void

setGeometricShapeType(geometricShapeType)

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

setGeometricShapeType(geometricShapeType: GeometricShapeType): void;

Paramètres

geometricShapeType

ExcelScript.GeometricShapeType

Retourne

void

setHorizontalAlignment(horizontalAlignment)

Spécifie l’alignement horizontal de l’étiquette de données du graphique. Pour plus d’informations, consultez ExcelScript.ChartTextHorizontalAlignment . Cette propriété est valide uniquement lorsque le de l’étiquette TextOrientation de données est 0.

setHorizontalAlignment(
            horizontalAlignment: ChartTextHorizontalAlignment
        ): void;

Paramètres

horizontalAlignment

ExcelScript.ChartTextHorizontalAlignment

Retourne

void

setLinkNumberFormat(linkNumberFormat)

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

setLinkNumberFormat(linkNumberFormat: boolean): void;

Paramètres

linkNumberFormat

boolean

Retourne

void

setNumberFormat(numberFormat)

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

setNumberFormat(numberFormat: string): void;

Paramètres

numberFormat

string

Retourne

void

setPosition(position)

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

setPosition(position: ChartDataLabelPosition): void;

Paramètres

position

ExcelScript.ChartDataLabelPosition

Retourne

void

Exemples

/**
 * This sample sets the position of data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the data label position to best fit.
  const series = chart.getSeries()[0];
  series.getDataLabels().setPosition(ExcelScript.ChartDataLabelPosition.bestFit);
}

setSeparator(separator)

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

setSeparator(separator: string): void;

Paramètres

separator

string

Retourne

void

setShowBubbleSize(showBubbleSize)

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

setShowBubbleSize(showBubbleSize: boolean): void;

Paramètres

showBubbleSize

boolean

Retourne

void

setShowCategoryName(showCategoryName)

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

setShowCategoryName(showCategoryName: boolean): void;

Paramètres

showCategoryName

boolean

Retourne

void

Exemples

/**
 * This sample shows category names in data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Show category names in the data labels.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowCategoryName(true);
}

setShowLeaderLines(showLeaderLines)

Spécifie si les lignes d’leader sont affichées pour les étiquettes de données. true si des lignes d’leader sont affichées ; sinon, false.

setShowLeaderLines(showLeaderLines: boolean): void;

Paramètres

showLeaderLines

boolean

Retourne

void

Exemples

/**
 * This sample enables leader lines for data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Enable leader lines.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowLeaderLines(true);
}

setShowLegendKey(showLegendKey)

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

setShowLegendKey(showLegendKey: boolean): void;

Paramètres

showLegendKey

boolean

Retourne

void

setShowPercentage(showPercentage)

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

setShowPercentage(showPercentage: boolean): void;

Paramètres

showPercentage

boolean

Retourne

void

Exemples

/**
 * This sample shows percentages in data labels.
 * This assumes the active worksheet has a pie chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Show percentages in the data labels.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowPercentage(true);
}

setShowSeriesName(showSeriesName)

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

setShowSeriesName(showSeriesName: boolean): void;

Paramètres

showSeriesName

boolean

Retourne

void

Exemples

/**
 * This sample controls series name visibility in data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Hide the series name in data labels.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowSeriesName(false);
}

setShowValue(showValue)

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

setShowValue(showValue: boolean): void;

Paramètres

showValue

boolean

Retourne

void

Exemples

/**
 * This sample shows values in data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Show values in the data labels.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowValue(true);
}

setTextOrientation(textOrientation)

Représente l’angle auquel le texte est orienté 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.

setTextOrientation(textOrientation: number): void;

Paramètres

textOrientation

number

Retourne

void

setVerticalAlignment(verticalAlignment)

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

setVerticalAlignment(
            verticalAlignment: ChartTextVerticalAlignment
        ): void;

Paramètres

verticalAlignment

ExcelScript.ChartTextVerticalAlignment

Retourne

void