Excel.PivotTableCollection interface

Representa uma coleção de todas as Tabelas Dinâmicas que fazem parte da pasta de trabalho ou planilha.

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.

getCount()

Obtém o número de tabelas dinâmicas na coleção.

getItem(name)

Obtém uma Tabela Dinâmica por nome.

getItemOrNullObject(name)

Obtém uma Tabela Dinâmica por nome. Se a tabela dinâmica não existir, retornará um objeto null.

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

refreshAll()

Atualiza todas as tabelas dinâmicas da coleção.

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
        ): PivotTable;

Parâmetros

name
string

O nome da nova tabela dinâmica.

source
Range | string | Table

Os dados de origem da nova tabela dinâmica, podem ser um intervalo (ou um endereço de cadeia de caracteres incluindo o nome da planilha) ou uma tabela.

destination
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

Exemplos

async function main(context: Excel.RequestContext) {
    let rangeToAnalyze = context.workbook.worksheets.getItem("Data").getRange("A1:E21");
    let 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(): ClientResult<number>;

Retornos

ClientResult<number>

getItem(name)

Obtém uma Tabela Dinâmica por nome.

getItem(name: string): PivotTable;

Parâmetros

name
string

Nome da Tabela Dinâmica a ser recuperada.

Retornos

getItemOrNullObject(name)

Obtém uma Tabela Dinâmica por nome. Se a tabela dinâmica não existir, retornará um objeto null.

getItemOrNullObject(name: string): PivotTable;

Parâmetros

name
string

Nome da Tabela Dinâmica a ser recuperada.

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[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void

refreshAll()

Atualiza todas as tabelas dinâmicas da coleção.

refreshAll(): void;

Retornos

void