ExcelScript.ChartDataLabels interface

Especifica se as etiquetas de dados geram automaticamente texto adequado com base no contexto.

getAutoText(): boolean;

Retornos

Especifica o formato das etiquetas de dados do gráfico, que inclui a formatação de tipo de letra e preenchimento.

getFormat(): ChartDataLabelFormat;

Retornos

Especifica o tipo de forma geométrica das etiquetas de dados. Veja ExcelScript.GeometricShapeType para obter detalhes. O valor é null se as etiquetas de dados não forem formas geométricas.

getGeometricShapeType(): GeometricShapeType;

Retornos

Especifica o alinhamento horizontal para a etiqueta de dados do gráfico. Veja ExcelScript.ChartTextHorizontalAlignment para obter detalhes. Esta propriedade só é válida quando a TextOrientation etiqueta de dados é 0.

getHorizontalAlignment(): ChartTextHorizontalAlignment;

Retornos

Obtém um objeto que representa as linhas de preenchimento das etiquetas de dados.

getLeaderLines(): ChartLeaderLines;

Retornos

Especifica se o formato de número está ligado às células. Se true, o formato de número será alterado nas etiquetas quando for alterado nas células.

getLinkNumberFormat(): boolean;

Retornos

Especifica o código de formato para etiquetas de dados.

getNumberFormat(): string;

Retornos

Valor que representa a posição da etiqueta de dados. Veja ExcelScript.ChartDataLabelPosition para obter detalhes.

getPosition(): ChartDataLabelPosition;

Retornos

Cadeia de caracteres que representa o separador usado para os rótulos de dados em um gráfico.

getSeparator(): string;

Retornos

Especifica se as etiquetas de dados são apresentadas como uma nota de aviso com a âncora de cauda anexada ao ponto de dados. Se true, a nota de aviso é um dos seguintes valores: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" ou "WedgeEllipseCallout".

getShowAsStickyCallout(): boolean;

Retornos

Especifica se o tamanho da bolha da etiqueta de dados está visível.

getShowBubbleSize(): boolean;

Retornos

Especifica se o nome da categoria da etiqueta de dados está visível.

getShowCategoryName(): boolean;

Retornos

Especifica se as linhas de preenchimento são apresentadas para as etiquetas de dados. true se forem apresentadas linhas de preenchimento; caso contrário, false.

getShowLeaderLines(): boolean;

Retornos

Especifica se a chave de legenda da etiqueta de dados está visível.

getShowLegendKey(): boolean;

Retornos

Especifica se a percentagem da etiqueta de dados está visível.

getShowPercentage(): boolean;

Retornos

Especifica se o nome da série de etiquetas de dados está visível.

getShowSeriesName(): boolean;

Retornos

Especifica se o valor da etiqueta de dados está visível.

getShowValue(): boolean;

Retornos

Representa o ângulo para o qual o texto é orientado para etiquetas de dados. O valor deve ser um número inteiro de -90 a 90 ou o número inteiro 180 para texto orientado verticalmente.

getTextOrientation(): number;

Retornos

Representa o alinhamento vertical do rótulo de dados do gráfico. Veja ExcelScript.ChartTextVerticalAlignment para obter detalhes. Esta propriedade só é válida quando TextOrientation a etiqueta de dados é -90, 90 ou 180.

getVerticalAlignment(): ChartTextVerticalAlignment;

Retornos

Especifica se as etiquetas de dados geram automaticamente texto adequado com base no contexto.

setAutoText(autoText: boolean): void;

Parâmetros

Retornos

Especifica o tipo de forma geométrica das etiquetas de dados. Veja ExcelScript.GeometricShapeType para obter detalhes. O valor é null se as etiquetas de dados não forem formas geométricas.

setGeometricShapeType(geometricShapeType: GeometricShapeType): void;

Parâmetros

Retornos

Especifica o alinhamento horizontal para a etiqueta de dados do gráfico. Veja ExcelScript.ChartTextHorizontalAlignment para obter detalhes. Esta propriedade só é válida quando a TextOrientation etiqueta de dados é 0.

setHorizontalAlignment(
            horizontalAlignment: ChartTextHorizontalAlignment
        ): void;

Parâmetros

Retornos

Especifica se o formato de número está ligado às células. Se true, o formato de número será alterado nas etiquetas quando for alterado nas células.

setLinkNumberFormat(linkNumberFormat: boolean): void;

Parâmetros

Retornos

Especifica o código de formato para etiquetas de dados.

setNumberFormat(numberFormat: string): void;

Parâmetros

Retornos

Valor que representa a posição da etiqueta de dados. Veja ExcelScript.ChartDataLabelPosition para obter detalhes.

setPosition(position: ChartDataLabelPosition): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Cadeia de caracteres que representa o separador usado para os rótulos de dados em um gráfico.

setSeparator(separator: string): void;

Parâmetros

Retornos

Especifica se o tamanho da bolha da etiqueta de dados está visível.

setShowBubbleSize(showBubbleSize: boolean): void;

Parâmetros

Retornos

Especifica se o nome da categoria da etiqueta de dados está visível.

setShowCategoryName(showCategoryName: boolean): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Especifica se as linhas de preenchimento são apresentadas para as etiquetas de dados. true se forem apresentadas linhas de preenchimento; caso contrário, false.

setShowLeaderLines(showLeaderLines: boolean): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Especifica se a chave de legenda da etiqueta de dados está visível.

setShowLegendKey(showLegendKey: boolean): void;

Parâmetros

Retornos

Especifica se a percentagem da etiqueta de dados está visível.

setShowPercentage(showPercentage: boolean): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Especifica se o nome da série de etiquetas de dados está visível.

setShowSeriesName(showSeriesName: boolean): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Especifica se o valor da etiqueta de dados está visível.

setShowValue(showValue: boolean): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Representa o ângulo para o qual o texto é orientado para etiquetas de dados. O valor deve ser um número inteiro de -90 a 90 ou o número inteiro 180 para texto orientado verticalmente.

setTextOrientation(textOrientation: number): void;

Parâmetros

Retornos

Representa o alinhamento vertical do rótulo de dados do gráfico. Veja ExcelScript.ChartTextVerticalAlignment para obter detalhes. Esta propriedade só é válida quando TextOrientation a etiqueta de dados é -90, 90 ou 180.

setVerticalAlignment(
            verticalAlignment: ChartTextVerticalAlignment
        ): void;

Parâmetros

Retornos