Compartilhar via

Excel.ChartDataLabel class

  • Referência
Pacote:
excel

Representa a etiqueta de dados de um ponto de gráfico.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Propriedades

autoText

Especifica se a etiqueta de dados gera automaticamente texto adequado com base no contexto.
context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
format

Representa o formato do rótulo de dados do gráfico.
formula

Valor de cadeia de caracteres que representa a fórmula do título do rótulo de dados usando a notação no estilo A1.
height

Retorna a altura, em pontos, do rótulo de dados do gráfico. O valor é null se a etiqueta de dados do gráfico não estiver visível.
horizontalAlignment

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

Representa a distância, em pontos, da borda esquerda do rótulo de dados do gráfico até a borda esquerda da área do gráfico. O valor é null se a etiqueta de dados do gráfico não estiver visível.
linkNumberFormat

Especifica se o formato de número está ligado às células (para que o formato de número seja alterado nas etiquetas quando for alterado nas células).
numberFormat

Valor de cadeia de caracteres que representa o código do formato do rótulo de dados.
position

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

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

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

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

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

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

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

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

Cadeia de caracteres que representa o texto do rótulo de dados em um gráfico.
textOrientation

Representa o ângulo para o qual o texto é orientado para a etiqueta de dados do gráfico. O valor deve ser um número inteiro de -90 a 90 ou o número inteiro 180 para texto orientado verticalmente.
top

Representa a distância, em pontos, da borda superior do rótulo de dados do gráfico até a borda superior da área do gráfico. O valor é null se a etiqueta de dados do gráfico não estiver visível.
verticalAlignment

Representa o alinhamento vertical do rótulo de dados do gráfico. Veja Excel.ChartTextVerticalAlignment para obter detalhes. Esta propriedade só é válida quando TextOrientation a etiqueta de dados é 0.
width

Retorna a largura, em pontos, do rótulo de dados do gráfico. O valor é null se a etiqueta de dados do gráfico não estiver 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. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.ChartDataLabel é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartDataLabelData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

autoText

Especifica se a etiqueta de dados gera automaticamente texto adequado com base no contexto.

autoText: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

format

Representa o formato do rótulo de dados do gráfico.

readonly format: Excel.ChartDataLabelFormat;

Valor da propriedade

Excel.ChartDataLabelFormat

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

formula

Valor de cadeia de caracteres que representa a fórmula do título do rótulo de dados usando a notação no estilo A1.

formula: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

height

Retorna a altura, em pontos, do rótulo de dados do gráfico. O valor é null se a etiqueta de dados do gráfico não estiver visível.

readonly height: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

horizontalAlignment

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

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

Valor da propriedade

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

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

left

Representa a distância, em pontos, da borda esquerda do rótulo de dados do gráfico até a borda esquerda da área do gráfico. O valor é null se a etiqueta de dados do gráfico não estiver visível.

left: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

linkNumberFormat

Especifica se o formato de número está ligado às células (para que o formato de número seja alterado nas etiquetas quando for alterado nas células).

linkNumberFormat: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

numberFormat

Valor de cadeia de caracteres que representa o código do formato do rótulo de dados.

numberFormat: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

position

Valor que representa a posição da etiqueta de dados. Veja 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 API: ExcelApi 1.7 ]

separator

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

separator: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

showBubbleSize

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

showBubbleSize: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

showCategoryName

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

showCategoryName: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

showLegendKey

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

showLegendKey: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

showPercentage

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

showPercentage: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

showSeriesName

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

showSeriesName: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

showValue

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

showValue: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

text

Cadeia de caracteres que representa o texto do rótulo de dados em um gráfico.

text: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

textOrientation

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

textOrientation: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

top

Representa a distância, em pontos, da borda superior do rótulo de dados do gráfico até a borda superior da área do gráfico. O valor é null se a etiqueta de dados do gráfico não estiver visível.

top: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

verticalAlignment

Representa o alinhamento vertical do rótulo de dados do gráfico. Veja Excel.ChartTextVerticalAlignment para obter detalhes. Esta propriedade só é válida quando TextOrientation a etiqueta de dados é 0.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

width

Retorna a largura, em pontos, do rótulo de dados do gráfico. O valor é null se a etiqueta de dados do gráfico não estiver visível.

readonly width: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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.ChartDataLabelLoadOptions): Excel.ChartDataLabel;

Parâmetros

options
Excel.Interfaces.ChartDataLabelLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.ChartDataLabel

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.ChartDataLabel

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

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Excel.ChartDataLabel

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties
Excel.Interfaces.ChartDataLabelUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente 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 quaisquer propriedades só de leitura.

Retornos

void

set(properties)

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

set(properties: Excel.ChartDataLabel): void;

Parâmetros

properties
Excel.ChartDataLabel

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.ChartDataLabel é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartDataLabelData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.ChartDataLabelData;

Retornos

Excel.Interfaces.ChartDataLabelData