Excel.DataPivotHierarchyCollection class
Representa uma coleção de itens DataPivotHierarchy associados à Tabela Dinâmica.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.8 ]
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. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| add(pivot |
Adiciona o PivotHierarchy ao eixo atual. |
| get |
Obtém o número de hierarquias dinâmicas na coleção. |
| get |
Obtém uma DataPivotHierarchy pelo respetivo nome ou ID. |
| get |
Obtém uma DataPivotHierarchy por nome. Se a DataPivotHierarchy não existir, este método devolve um objeto com a respetiva |
| 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 |
| remove(Data |
Remove o PivotHierarchy do eixo atual. |
| 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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.DataPivotHierarchy[];Valor da propriedade
Detalhes do método
add(pivotHierarchy)
Adiciona o PivotHierarchy ao eixo atual.
add(pivotHierarchy: Excel.PivotHierarchy): Excel.DataPivotHierarchy;Parâmetros
- pivotHierarchy
- Excel.PivotHierarchy
Retornos
Comentários
getCount()
Obtém o número de hierarquias dinâmicas na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
getItem(name)
Obtém uma DataPivotHierarchy pelo respetivo nome ou ID.
getItem(name: string): Excel.DataPivotHierarchy;Parâmetros
- name
-
string
Nome da DataPivotHierarchy a obter.
Retornos
Comentários
getItemOrNullObject(name)
Obtém uma DataPivotHierarchy por nome. Se a DataPivotHierarchy não existir, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getItemOrNullObject(name: string): Excel.DataPivotHierarchy;Parâmetros
- name
-
string
Nome da DataPivotHierarchy a obter.
Retornos
Comentários
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.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.DataPivotHierarchyCollection;Parâmetros
- options
-
Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
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.DataPivotHierarchyCollection;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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?: OfficeExtension.LoadOption): Excel.DataPivotHierarchyCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
remove(DataPivotHierarchy)
Remove o PivotHierarchy do eixo atual.
remove(DataPivotHierarchy: Excel.DataPivotHierarchy): void;Parâmetros
- DataPivotHierarchy
- Excel.DataPivotHierarchy
Retornos
void
Comentários
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.DataPivotHierarchyCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.DataPivotHierarchyCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.DataPivotHierarchyCollectionData;