Excel.PivotTable class

Referência

Pacote:: excel

Representa uma Tabela Dinâmica do Excel. Para saber mais sobre o modelo de objeto de Tabela Dinâmica, leia Trabalhar com Tabelas Dinâmicas com a API JavaScript do Excel.

Extends: OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

Propriedades

allowMultipleFiltersPerField	Especifica se a Tabela Dinâmica permite a aplicação de vários Filtros Dinâmicos num determinado Campo Dinâmico na tabela.
columnHierarchies	As hierarquias de pivô da coluna da Tabela Dinâmica.
context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
dataHierarchies	As hierarquias dinâmicas de dados da Tabela Dinâmica.
enableDataValueEditing	Especifica se a Tabela Dinâmica permite que os valores no corpo dos dados sejam editados pelo utilizador.
filterHierarchies	As hierarquias de pivô do filtro da Tabela Dinâmica.
hierarchies	Hierarquias pivô da Tabela Dinâmica.
id	ID da Tabela Dinâmica.
layout	O PivotLayout descreve o layout e estrutura visual da Tabela Dinâmica.
name	Nome da Tabela Dinâmica.
refreshOnOpen	Especifica se a tabela dinâmica é atualizada quando o livro é aberto. Corresponde à definição "Atualizar ao carregar" na IU.
rowHierarchies	As hierarquias de pivô de linha da Tabela Dinâmica.
useCustomSortLists	Especifica se a Tabela Dinâmica utiliza listas personalizadas ao ordenar.
worksheet	A planilha que contém a Tabela Dinâmica atual.

Métodos

delete()	Exclui a Tabela Dinâmica.
getDataSourceString()	Devolve a representação de cadeia da origem de dados da tabela dinâmica. Atualmente, este método suporta representações de cadeias para objetos de tabela e intervalo. Caso contrário, devolve uma cadeia vazia.
getDataSourceType()	Obtém o tipo da origem de dados da Tabela Dinâmica.
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(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
refresh()	Atualiza a Tabela Dinâmica.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
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 Excel.PivotTable original é um objeto de API, o `toJSON` método devolve um objeto JavaScript simples (escrito como `Excel.Interfaces.PivotTableData`) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

allowMultipleFiltersPerField

Especifica se a Tabela Dinâmica permite a aplicação de vários Filtros Dinâmicos num determinado Campo Dinâmico na tabela.

allowMultipleFiltersPerField: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

columnHierarchies

As hierarquias de pivô da coluna da Tabela Dinâmica.

readonly columnHierarchies: Excel.RowColumnPivotHierarchyCollection;

Valor da propriedade

Excel.RowColumnPivotHierarchyCollection

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 pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");       

    // Check if the PivotTable already has a column.
    const column = pivotTable.columnHierarchies.getItemOrNullObject("Farm");
    column.load("id");
    await context.sync();

    if (column.isNullObject) {
        // Adding the farm column to the column hierarchy automatically removes it from the row hierarchy.
        pivotTable.columnHierarchies.add(pivotTable.hierarchies.getItem("Farm"));
    } else {
        pivotTable.columnHierarchies.remove(column);
    }

    await context.sync();
});

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

Excel.RequestContext

dataHierarchies

As hierarquias dinâmicas de dados da Tabela Dinâmica.

readonly dataHierarchies: Excel.DataPivotHierarchyCollection;

Valor da propriedade

Excel.DataPivotHierarchyCollection

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 pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
    pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold at Farm"));
    pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold Wholesale"));

    await context.sync();
});

enableDataValueEditing

Especifica se a Tabela Dinâmica permite que os valores no corpo dos dados sejam editados pelo utilizador.

enableDataValueEditing: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

filterHierarchies

As hierarquias de pivô do filtro da Tabela Dinâmica.

readonly filterHierarchies: Excel.FilterPivotHierarchyCollection;

Valor da propriedade

Excel.FilterPivotHierarchyCollection

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-filters-and-summaries.yaml

async function filter(functionType: Excel.AggregationFunction) {
    await Excel.run(async (context) => {
        const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
        const filters = pivotTable.filterHierarchies;
        const filter = filters.getItemOrNullObject("Classification");
        filter.load();
        await context.sync();

        // Add the Classification hierarchy to the filter, if it's not already there.
        if (filter.isNullObject) {
            filters.add(pivotTable.hierarchies.getItem("Classification"));
            await context.sync();
        }
    });
}

hierarchies

Hierarquias pivô da Tabela Dinâmica.

readonly hierarchies: Excel.PivotHierarchyCollection;

Valor da propriedade

Excel.PivotHierarchyCollection

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

id

ID da Tabela Dinâmica.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.5 ]

layout

O PivotLayout descreve o layout e estrutura visual da Tabela Dinâmica.

readonly layout: Excel.PivotLayout;

Valor da propriedade

Excel.PivotLayout

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 pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
    pivotTable.layout.load("layoutType");
    await context.sync();

    // Cycle between the three layout types.
    if (pivotTable.layout.layoutType === "Compact") {
        pivotTable.layout.layoutType = "Outline";
    } else if (pivotTable.layout.layoutType === "Outline") {
        pivotTable.layout.layoutType = "Tabular";
    } else {
        pivotTable.layout.layoutType = "Compact";
    }
    await context.sync();
    console.log("Pivot layout is now " + pivotTable.layout.layoutType);
});

name

Nome da Tabela Dinâmica.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

refreshOnOpen

Especifica se a tabela dinâmica é atualizada quando o livro é aberto. Corresponde à definição "Atualizar ao carregar" na IU.

refreshOnOpen: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.13 ]

rowHierarchies

As hierarquias de pivô de linha da Tabela Dinâmica.

readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection;

Valor da propriedade

Excel.RowColumnPivotHierarchyCollection

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

useCustomSortLists

Especifica se a Tabela Dinâmica utiliza listas personalizadas ao ordenar.

useCustomSortLists: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

worksheet

A planilha que contém a Tabela Dinâmica atual.

readonly worksheet: Excel.Worksheet;

Valor da propriedade

Excel.Worksheet

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

Detalhes do método

delete()

Exclui a Tabela Dinâmica.

delete(): void;

Retornos

void

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) => {
    context.workbook.worksheets.getItem("Pivot").pivotTables.getItem("Farm Sales").delete();

    await context.sync();
});

getDataSourceString()

Devolve a representação de cadeia da origem de dados da tabela dinâmica. Atualmente, este método suporta representações de cadeias para objetos de tabela e intervalo. Caso contrário, devolve uma cadeia vazia.

getDataSourceString(): OfficeExtension.ClientResult<string>;

Retornos

OfficeExtension.ClientResult<string>

Comentários

[ Conjunto de API: ExcelApi 1.15 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-source-data.yaml

// This function logs information about the data source of a PivotTable.
await Excel.run(async (context) => {
  const worksheet = context.workbook.worksheets.getItem("TotalPivot");
  const pivotTable = worksheet.pivotTables.getItem("All Farm Sales");

  // Retrieve the type and string representation of the data source of the PivotTable.
  const pivotTableDataSourceType = pivotTable.getDataSourceType();
  const pivotTableDataSourceString = pivotTable.getDataSourceString();
  await context.sync();

  // Log the data source information.
  console.log("Data source: " + pivotTableDataSourceString.value);
  console.log("Source type: " + pivotTableDataSourceType.value);
});

getDataSourceType()

Obtém o tipo da origem de dados da Tabela Dinâmica.

getDataSourceType(): OfficeExtension.ClientResult<Excel.DataSourceType>;

Retornos

OfficeExtension.ClientResult<Excel.DataSourceType>

Comentários

[ Conjunto de API: ExcelApi 1.15 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-source-data.yaml

// This function logs information about the data source of a PivotTable.
await Excel.run(async (context) => {
  const worksheet = context.workbook.worksheets.getItem("TotalPivot");
  const pivotTable = worksheet.pivotTables.getItem("All Farm Sales");

  // Retrieve the type and string representation of the data source of the PivotTable.
  const pivotTableDataSourceType = pivotTable.getDataSourceType();
  const pivotTableDataSourceString = pivotTable.getDataSourceString();
  await context.sync();

  // Log the data source information.
  console.log("Data source: " + pivotTableDataSourceString.value);
  console.log("Source type: " + pivotTableDataSourceType.value);
});

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

Parâmetros

options: Excel.Interfaces.PivotTableLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.PivotTable

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.PivotTable;

Parâmetros

propertyNames: string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.PivotTable

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?: {
            select?: string;
            expand?: string;
        }): Excel.PivotTable;

Parâmetros

propertyNamesAndPaths: { select?: string; expand?: string; }

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

Excel.PivotTable

refresh()

Atualiza a Tabela Dinâmica.

refresh(): void;

Retornos

void

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();
});

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.PivotTableUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties: Excel.Interfaces.PivotTableUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options: OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Excel.PivotTable): void;

Parâmetros

properties: Excel.PivotTable

Retornos

void

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 Excel.PivotTable original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.PivotTableData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.PivotTableData;

Retornos

Excel.Interfaces.PivotTableData

Compartilhar via

Excel.PivotTable class

Comentários

Propriedades

Métodos

Detalhes da propriedade

allowMultipleFiltersPerField

Valor da propriedade

Comentários

columnHierarchies

Valor da propriedade

Comentários

Exemplos

context

Valor da propriedade

dataHierarchies

Valor da propriedade

Comentários

Exemplos

enableDataValueEditing

Valor da propriedade

Comentários

filterHierarchies

Valor da propriedade

Comentários

Exemplos

hierarchies

Valor da propriedade

Comentários

id

Valor da propriedade

Comentários

layout

Valor da propriedade

Comentários

Exemplos

name

Valor da propriedade

Comentários

refreshOnOpen

Valor da propriedade

Comentários

rowHierarchies

Valor da propriedade

Comentários

useCustomSortLists

Valor da propriedade

Comentários

worksheet

Valor da propriedade

Comentários

Detalhes do método

delete()

Retornos

Comentários

Exemplos

getDataSourceString()

Retornos

Comentários

Exemplos

getDataSourceType()

Retornos

Comentários

Exemplos

load(options)

Parâmetros

Retornos

load(propertyNames)

Parâmetros

Retornos

load(propertyNamesAndPaths)

Parâmetros

Retornos

refresh()

Retornos

Comentários

Exemplos

set(properties, options)

Parâmetros

Retornos