Excel.PivotItemCollection class
Representa uma coleção de todos osItems Dinâmicos relacionados com o campo dinâmico principal.
- 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
get |
Obtém o número deItems Dinâmicos na coleção. |
get |
Obtém um PivotItem pelo respetivo nome ou ID. |
get |
Obtém um PivotItem pelo nome. Se o PivotItem 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 |
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.PivotItem[];
Valor da propriedade
Detalhes do método
getCount()
Obtém o número deItems Dinâmicos na coleção.
getCount(): OfficeExtension.ClientResult<number>;
Retornos
OfficeExtension.ClientResult<number>
Comentários
getItem(name)
Obtém um PivotItem pelo respetivo nome ou ID.
getItem(name: string): Excel.PivotItem;
Parâmetros
- name
-
string
Nome doItem Dinâmico a obter.
Retornos
Comentários
getItemOrNullObject(name)
Obtém um PivotItem pelo nome. Se o PivotItem 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.PivotItem;
Parâmetros
- name
-
string
Nome doItem Dinâmico 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.PivotItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotItemCollection;
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.PivotItemCollection;
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.PivotItemCollection;
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
toJSON()
Substitui o método JavaScript toJSON()
para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify()
. (JSON.stringify
por sua vez, chama o toJSON
método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.PivotItemCollection
é um objeto de API, o toJSON
método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.PivotItemCollectionData
) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.PivotItemCollectionData;