Excel.PivotTableScopedCollection class
Representa uma coleção de tabelas dinâmicas com escopo. As Tabelas Dinâmicas são classificadas com base no local do canto superior esquerdo da Tabela Dinâmica. Eles 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 de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host 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 da coleção. As Tabelas Dinâmicas na coleção são classificadas de cima para baixo e da esquerda para a direita, de modo que a tabela superior esquerda é a primeira Tabela Dinâmica da coleção. |
| get |
Obtém a primeira Tabela Dinâmica da coleção. As Tabelas Dinâmicas na coleção são classificadas de cima para baixo e da esquerda para a direita, de modo que a tabela superior esquerda seja a primeira Tabela Dinâmica da coleção. Se a coleção estiver vazia, esse método retornará um objeto com sua |
| 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, esse método retornará um objeto com sua |
| 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 de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host 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 da coleção. As Tabelas Dinâmicas na coleção são classificadas de cima para baixo e da esquerda para a direita, de modo que a tabela superior esquerda é a primeira Tabela Dinâmica da coleção.
getFirst(): Excel.PivotTable;Retornos
Comentários
getFirstOrNullObject()
Obtém a primeira Tabela Dinâmica da coleção. As Tabelas Dinâmicas na coleção são classificadas de cima para baixo e da esquerda para a direita, de modo que a tabela superior esquerda seja a primeira Tabela Dinâmica da coleção. Se a coleção estiver vazia, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getFirstOrNullObject(): 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, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades 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 quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam 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?: OfficeExtension.LoadOption): Excel.PivotTableScopedCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Considerando que o objeto original Excel.PivotTableScopedCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado 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;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de