Excel.ChartDataTable class
Representa o objeto da tabela de dados de um gráfico.
- Extends
Comentários
[Conjunto de apis: ExcelApi 1.14]
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| format | Representa o formato de uma tabela de dados do gráfico, que inclui o formato de preenchimento, fonte e borda. |
| show |
Especifica se a borda horizontal da tabela de dados deve ser exibida. |
| show |
Especifica se a chave de legenda da tabela de dados deve ser mostrada. |
| show |
Especifica se o contorno da tabela de dados deve ser exibido. |
| show |
Especifica se a borda vertical da tabela de dados deve ser exibida. |
| visible | Especifica se a tabela de dados do gráfico deve ser mostrada. |
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. 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 |
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
Representa o formato de uma tabela de dados do gráfico, que inclui o formato de preenchimento, fonte e borda.
readonly format: Excel.ChartDataTableFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.14]
showHorizontalBorder
Especifica se a borda horizontal da tabela de dados deve ser exibida.
showHorizontalBorder: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.14]
showLegendKey
Especifica se a chave de legenda da tabela de dados deve ser mostrada.
showLegendKey: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.14]
showOutlineBorder
Especifica se o contorno da tabela de dados deve ser exibido.
showOutlineBorder: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.14]
showVerticalBorder
Especifica se a borda vertical da tabela de dados deve ser exibida.
showVerticalBorder: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.14]
visible
Especifica se a tabela de dados do gráfico deve ser mostrada.
visible: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.14]
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.ChartDataTableLoadOptions): Excel.ChartDataTable;Parâmetros
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.ChartDataTable;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
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.ChartDataTable;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.ChartDataTableUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.ChartDataTableUpdateData
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.ChartDataTable): void;Parâmetros
- properties
- Excel.ChartDataTable
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.ChartDataTable é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartDataTableData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.ChartDataTableData;