Excel.ChartDataLabels class
Representa uma coleção de todos os rótulos de dados em um ponto do gráfico.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
| 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 | Especifica o formato das etiquetas de dados do gráfico, que inclui a formatação de tipo de letra e preenchimento. |
| position | Valor que representa a posição da etiqueta de dados. Veja |
| separator | Cadeia de caracteres que representa o separador usado para os rótulos de dados em um gráfico. |
| show |
Especifica se o tamanho da bolha da etiqueta de dados está visível. |
| show |
Especifica se o nome da categoria da etiqueta de dados está visível. |
| show |
Especifica se a chave de legenda da etiqueta de dados está visível. |
| show |
Especifica se a percentagem da etiqueta de dados está visível. |
| show |
Especifica se o nome da série de etiquetas de dados está visível. |
| show |
Especifica se o valor da etiqueta de dados está visível. |
Métodos
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| 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 |
Detalhes da propriedade
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
format
Especifica o formato das etiquetas de dados do gráfico, que inclui a formatação de tipo de letra e preenchimento.
readonly format: Excel.ChartDataLabelFormat;Valor da propriedade
Comentários
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
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
showBubbleSize
Especifica se o tamanho da bolha da etiqueta de dados está visível.
showBubbleSize: boolean;Valor da propriedade
boolean
Comentários
showCategoryName
Especifica se o nome da categoria da etiqueta de dados está visível.
showCategoryName: boolean;Valor da propriedade
boolean
Comentários
showLegendKey
Especifica se a chave de legenda da etiqueta de dados está visível.
showLegendKey: boolean;Valor da propriedade
boolean
Comentários
showPercentage
Especifica se a percentagem da etiqueta de dados está visível.
showPercentage: boolean;Valor da propriedade
boolean
Comentários
showSeriesName
Especifica se o nome da série de etiquetas de dados está visível.
showSeriesName: boolean;Valor da propriedade
boolean
Comentários
showValue
Especifica se o valor da etiqueta de dados está visível.
showValue: boolean;Valor da propriedade
boolean
Comentários
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
Fornece opções para as propriedades do objeto a carregar.
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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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 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
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.ChartDataLabelsUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.ChartDataLabelsUpdateData
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.ChartDataLabels): void;Parâmetros
- properties
- Excel.ChartDataLabels
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.ChartDataLabels é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartDataLabelsData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.ChartDataLabelsData;