Excel.ChartDataLabels class

Representa uma coleção de todos os rótulos de dados em um ponto do gráfico.

Extends

Propriedades

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

format

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

position

Valor que representa a posição do rótulo de dados. Consulte Excel.ChartDataLabelPosition para obter detalhes.

separator

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

showBubbleSize

Especifica se o tamanho da bolha do rótulo de dados está visível.

showCategoryName

Especifica se o nome da categoria do rótulo de dados é visível.

showLegendKey

Especifica se a chave da legenda do rótulo de dados está visível.

showPercentage

Especifica se a porcentagem do rótulo de dados está visível.

showSeriesName

Especifica se o nome da série de rótulos de dados é visível.

showValue

Especifica se o valor do rótulo de dados é visível.

Métodos

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.ChartDataLabels é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartDataLabelsData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

format

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

readonly format: Excel.ChartDataLabelFormat;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

position

Valor que representa a posição do rótulo de dados. Consulte Excel.ChartDataLabelPosition para obter detalhes.

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

Valor da propriedade

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

Comentários

Conjunto de APIs: ExcelApi 1.1

separator

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

separator: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: ExcelApi 1.1

showBubbleSize

Especifica se o tamanho da bolha do rótulo de dados está visível.

showBubbleSize: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

showCategoryName

Especifica se o nome da categoria do rótulo de dados é visível.

showCategoryName: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

showLegendKey

Especifica se a chave da legenda do rótulo de dados está visível.

showLegendKey: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

showPercentage

Especifica se a porcentagem do rótulo de dados está visível.

showPercentage: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

showSeriesName

Especifica se o nome da série de rótulos de dados é visível.

showSeriesName: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

showValue

Especifica se o valor do rótulo de dados é visível.

showValue: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

Detalhes do método

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;

Parâmetros

options
Excel.Interfaces.ChartDataLabelsLoadOptions

Fornece opções para quais propriedades do objeto devem ser carregadas.

Retornos

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Excel.ChartDataLabels;

Parâmetros

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.

Retornos

Exemplos

// 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)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartDataLabels;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.ChartDataLabelsUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.ChartDataLabelsUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.ChartDataLabels): void;

Parâmetros

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.ChartDataLabels é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartDataLabelsData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.ChartDataLabelsData;

Retornos