Excel.PivotTableCollection class
Representa uma coleção de todas as Tabelas Dinâmicas que fazem parte da pasta de trabalho ou planilha.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.3 ]
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(name, source, destination) | Adicione uma tabela dinâmica com base nos dados de origem especificados e insira-a na célula superior esquerda do intervalo de destino. |
| get |
Obtém o número de tabelas dinâmicas 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 |
| refresh |
Atualiza todas as tabelas dinâmicas da coleção. |
| 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
add(name, source, destination)
Adicione uma tabela dinâmica com base nos dados de origem especificados e insira-a na célula superior esquerda do intervalo de destino.
add(name: string, source: Range | string | Table, destination: Range | string): Excel.PivotTable;Parâmetros
- name
-
string
O nome da nova tabela dinâmica.
- source
-
Excel.Range | string | Excel.Table
Os dados de origem da nova tabela dinâmica podem ser um intervalo (ou um endereço de cadeia, incluindo o nome da folha de cálculo) ou uma tabela.
- destination
-
Excel.Range | string
A célula no canto superior esquerdo do intervalo de destino do relatório de tabela dinâmica (o intervalo na planilha em que o relatório resultante será inserido).
Retornos
Devolve a tabela dinâmica recentemente inserida.
Comentários
[ Conjunto de API: ExcelApi 1.8 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml
await Excel.run(async (context) => {
const rangeToAnalyze = context.workbook.worksheets.getItem("Data").getRange("A1:E21");
const rangeToPlacePivot = context.workbook.worksheets.getItem("Pivot").getRange("A2");
context.workbook.worksheets.getItem("Pivot").pivotTables.add("Farm Sales", rangeToAnalyze, rangeToPlacePivot);
await context.sync();
});
getCount()
Obtém o número de tabelas dinâmicas na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
getItem(name)
Obtém uma Tabela Dinâmica por nome.
getItem(name: string): Excel.PivotTable;Parâmetros
- name
-
string
Nome da Tabela Dinâmica a ser recuperada.
Retornos
Comentários
[ Conjunto de API: ExcelApi 1.3 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-refresh.yaml
// This function refreshes the "Farm Sales" PivotTable,
// which updates the PivotTable with changes made to the source table.
await Excel.run(async (context) => {
const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
pivotTable.refresh();
await context.sync();
});
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.PivotTableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableCollection;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.PivotTableCollection;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.PivotTableCollection;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
refreshAll()
Atualiza todas as tabelas dinâmicas da coleção.
refreshAll(): void;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.PivotTableCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.PivotTableCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.PivotTableCollectionData;