Excel.DataPivotHierarchy class
Representa a DataPivotHierarchy do Excel.
- Extends
Comentários
[Conjunto de apis: ExcelApi 1.8]
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| field | Retorna PivotFields associados a DataPivotHierarchy. |
| id | ID da DataPivotHierarchy. |
| name | Nome da DataPivotHierarchy. |
| number |
Formato de número do DataPivotHierarchy. |
| position | Posição da DataPivotHierarchy. |
| show |
Especifica se os dados devem ser exibidos como um cálculo de resumo específico. |
| summarize |
Especifica se todos os itens da DataPivotHierarchy são mostrados. |
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. |
| set |
Redefina a DataPivotHierarchy para os valores padrão. |
| 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
field
Retorna PivotFields associados a DataPivotHierarchy.
readonly field: Excel.PivotField;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.8]
id
ID da DataPivotHierarchy.
readonly id: string;Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.8]
name
Nome da DataPivotHierarchy.
name: string;Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.8]
numberFormat
Formato de número do DataPivotHierarchy.
numberFormat: string;Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.8]
position
Posição da DataPivotHierarchy.
position: number;Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.8]
showAs
Especifica se os dados devem ser exibidos como um cálculo de resumo específico.
showAs: Excel.ShowAsRule;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.8]
summarizeBy
Especifica se todos os itens da DataPivotHierarchy são mostrados.
summarizeBy: Excel.AggregationFunction | "Unknown" | "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP";Valor da propriedade
Excel.AggregationFunction | "Unknown" | "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP"
Comentários
[Conjunto de apis: 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.DataPivotHierarchyLoadOptions): Excel.DataPivotHierarchy;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.DataPivotHierarchy;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.DataPivotHierarchy;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.DataPivotHierarchyUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
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.DataPivotHierarchy): void;Parâmetros
- properties
- Excel.DataPivotHierarchy
Retornos
void
setToDefault()
Redefina a DataPivotHierarchy para os valores padrão.
setToDefault(): void;Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.8]
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.DataPivotHierarchy é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.DataPivotHierarchyData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.DataPivotHierarchyData;