Excel.PivotTableScopedCollection class
Representa uma coleção de tabelas dinâmicas no âmbito. As tabelas dinâmicas são ordenadas com base na localização do canto superior esquerdo da tabela dinâmica. São ordenados de cima para baixo e, em seguida, da esquerda para a direita.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.12 ]
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 de tabelas dinâmicas na coleção. |
| get |
Obtém a primeira tabela dinâmica na coleção. As tabelas dinâmicas na coleção são ordenadas de cima para baixo e da esquerda para a direita, de modo que a tabela superior esquerda seja a primeira tabela dinâmica na coleção. |
| get |
Obtém uma Tabela Dinâmica por nome. |
| get |
Obtém uma Tabela Dinâmica por nome. Se a tabela dinâmica 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.PivotTable[];Valor da propriedade
Detalhes do método
getCount()
Obtém o número de tabelas dinâmicas na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
getFirst()
Obtém a primeira tabela dinâmica na coleção. As tabelas dinâmicas na coleção são ordenadas de cima para baixo e da esquerda para a direita, de modo que a tabela superior esquerda seja a primeira tabela dinâmica na coleção.
getFirst(): Excel.PivotTable;Retornos
Comentários
getItem(key)
Obtém uma Tabela Dinâmica por nome.
getItem(key: string): Excel.PivotTable;Parâmetros
- key
-
string
Nome da Tabela Dinâmica a ser recuperada.
Retornos
Comentários
getItemOrNullObject(name)
Obtém uma Tabela Dinâmica por nome. Se a tabela dinâmica 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.PivotTable;Parâmetros
- name
-
string
Nome da Tabela Dinâmica a ser recuperada.
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.PivotTableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableScopedCollection;Parâmetros
- options
-
Excel.Interfaces.PivotTableScopedCollectionLoadOptions & 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.PivotTableScopedCollection;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.PivotTableScopedCollection;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.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.PivotTableScopedCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.PivotTableScopedCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.PivotTableScopedCollectionData;