Excel.PivotTable class
Representa uma Tabela Dinâmica do Excel. Para saber mais sobre o modelo de objeto tabela dinâmica, leia Trabalhar com Tabelas Dinâmicas usando a API JavaScript do Excel.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.3 ]
Propriedades
| allow |
Especifica se a Tabela Dinâmica permite a aplicação de vários PivotFilters em um determinado PivotField na tabela. |
| column |
As hierarquias de pivô da coluna da Tabela Dinâmica. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| data |
As hierarquias dinâmicas de dados da Tabela Dinâmica. |
| enable |
Especifica se a Tabela Dinâmica permite que valores no corpo dos dados sejam editados pelo usuário. |
| filter |
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. |
| refresh |
Especifica se a Tabela Dinâmica é atualizada quando a pasta de trabalho é aberta. Corresponde à configuração "Atualizar na carga" na interface do usuário. |
| row |
As hierarquias de pivô de linha da Tabela Dinâmica. |
| use |
Especifica se a Tabela Dinâmica usa listas personalizadas ao classificar. |
| worksheet | A planilha que contém a Tabela Dinâmica atual. |
Métodos
| delete() | Exclui a Tabela Dinâmica. |
| get |
Retorna a representação de cadeia de caracteres da fonte de dados para a Tabela Dinâmica. Atualmente, esse método dá suporte a representações de cadeia de caracteres para objetos de tabela e intervalo. Caso contrário, ele retorna uma cadeia de caracteres vazia. |
| get |
Obtém o tipo da fonte de dados da Tabela Dinâmica. |
| 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 a Tabela Dinâmica. |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
allowMultipleFiltersPerField
Especifica se a Tabela Dinâmica permite a aplicação de vários PivotFilters em um determinado PivotField na tabela.
allowMultipleFiltersPerField: boolean;Valor da propriedade
boolean
Comentários
columnHierarchies
As hierarquias de pivô da coluna da Tabela Dinâmica.
readonly columnHierarchies: Excel.RowColumnPivotHierarchyCollection;Valor da propriedade
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 de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
dataHierarchies
As hierarquias dinâmicas de dados da Tabela Dinâmica.
readonly dataHierarchies: Excel.DataPivotHierarchyCollection;Valor da propriedade
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 valores no corpo dos dados sejam editados pelo usuário.
enableDataValueEditing: boolean;Valor da propriedade
boolean
Comentários
filterHierarchies
As hierarquias de pivô do filtro da Tabela Dinâmica.
readonly filterHierarchies: Excel.FilterPivotHierarchyCollection;Valor da propriedade
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
Comentários
id
ID da Tabela Dinâmica.
readonly id: string;Valor da propriedade
string
Comentários
layout
O PivotLayout descreve o layout e estrutura visual da Tabela Dinâmica.
readonly layout: Excel.PivotLayout;Valor da propriedade
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
refreshOnOpen
Especifica se a Tabela Dinâmica é atualizada quando a pasta de trabalho é aberta. Corresponde à configuração "Atualizar na carga" na interface do usuário.
refreshOnOpen: boolean;Valor da propriedade
boolean
Comentários
rowHierarchies
As hierarquias de pivô de linha da Tabela Dinâmica.
readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection;Valor da propriedade
Comentários
useCustomSortLists
Especifica se a Tabela Dinâmica usa listas personalizadas ao classificar.
useCustomSortLists: boolean;Valor da propriedade
boolean
Comentários
worksheet
A planilha que contém a Tabela Dinâmica atual.
readonly worksheet: Excel.Worksheet;Valor da propriedade
Comentários
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()
Retorna a representação de cadeia de caracteres da fonte de dados para a Tabela Dinâmica. Atualmente, esse método dá suporte a representações de cadeia de caracteres para objetos de tabela e intervalo. Caso contrário, ele retorna uma cadeia de caracteres 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 fonte de dados da Tabela Dinâmica.
getDataSourceType(): OfficeExtension.ClientResult<Excel.DataSourceType>;Retornos
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
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.PivotTable;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?: {
select?: string;
expand?: string;
}): Excel.PivotTable;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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
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. Você pode passar um objeto simples com as propriedades apropriadas 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 estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.PivotTable original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.PivotTableData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.PivotTableData;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