ExcelScript.DataPivotHierarchy interface

Pacote:

ExcelScript

Representa a DataPivotHierarchy do Excel.

Comentários

Exemplos

/**
 *  This sample sorts the rows of a PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get an existing PivotTable.
  const pivotTable = workbook.getPivotTable("Farm Sales");

  // Get the data hierarchy to use as the basis of the sort.
  const valueFieldToSortOn: ExcelScript.DataPivotHierarchy = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");

  // Get the row to sort.
  const rowToSort: ExcelScript.RowColumnPivotHierarchy = pivotTable.getRowHierarchy("Farm");

  // Sort the "Farm" row's only field by the values in "Sum of Crates Sold Wholesale".
  rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending, valueFieldToSortOn);
}

Métodos

getField()	Retorna PivotFields associados a DataPivotHierarchy.
getId()	ID da DataPivotHierarchy.
getName()	Nome da DataPivotHierarchy.
getNumberFormat()	Formato de número do DataPivotHierarchy.
getPosition()	Posição da DataPivotHierarchy.
getShowAs()	Especifica se os dados devem ser apresentados como um cálculo de resumo específico.
getSummarizeBy()	Especifica se todos os itens da DataPivotHierarchy são apresentados.
setName(name)	Nome da DataPivotHierarchy.
setNumberFormat(numberFormat)	Formato de número do DataPivotHierarchy.
setPosition(position)	Posição da DataPivotHierarchy.
setShowAs(showAs)	Especifica se os dados devem ser apresentados como um cálculo de resumo específico.
setSummarizeBy(summarizeBy)	Especifica se todos os itens da DataPivotHierarchy são apresentados.
setToDefault()	Redefina a DataPivotHierarchy para os valores padrão.

Detalhes do método

getField()

Retorna PivotFields associados a DataPivotHierarchy.

getField(): PivotField;

Retornos

ExcelScript.PivotField

getId()

ID da DataPivotHierarchy.

getId(): string;

Retornos

string

getName()

Nome da DataPivotHierarchy.

getName(): string;

Retornos

string

getNumberFormat()

Formato de número do DataPivotHierarchy.

getNumberFormat(): string;

Retornos

string

getPosition()

Posição da DataPivotHierarchy.

getPosition(): number;

Retornos

number

getShowAs()

Especifica se os dados devem ser apresentados como um cálculo de resumo específico.

getShowAs(): ShowAsRule;

Retornos

ExcelScript.ShowAsRule

getSummarizeBy()

Especifica se todos os itens da DataPivotHierarchy são apresentados.

getSummarizeBy(): AggregationFunction;

Retornos

ExcelScript.AggregationFunction

setName(name)

Nome da DataPivotHierarchy.

setName(name: string): void;

Parâmetros

name

string

Retornos

void

setNumberFormat(numberFormat)

Formato de número do DataPivotHierarchy.

setNumberFormat(numberFormat: string): void;

Parâmetros

numberFormat

string

Retornos

void

setPosition(position)

Posição da DataPivotHierarchy.

setPosition(position: number): void;

Parâmetros

position

number

Retornos

void

setShowAs(showAs)

Especifica se os dados devem ser apresentados como um cálculo de resumo específico.

setShowAs(showAs: ShowAsRule): void;

Parâmetros

showAs

ExcelScript.ShowAsRule

Retornos

void

Exemplos

/**
 * The script changes the display for "Crates Sold at Farm".
 * It shows the percentage of the grand total, 
 * instead of the default sum.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Pivot".
  const farmPivot = workbook.getPivotTable("Farm Pivot");

  // Get the data hierarchy "Sum of Crates Sold at Farm".
  const farmSales = farmPivot.getDataHierarchy("Sum of Crates Sold at Farm");

  // Show the data as a percentage of the grand total.
  farmSales.setShowAs({
    calculation: ExcelScript.ShowAsCalculation.percentOfGrandTotal
  });
}

setSummarizeBy(summarizeBy)

Especifica se todos os itens da DataPivotHierarchy são apresentados.

setSummarizeBy(summarizeBy: AggregationFunction): void;

Parâmetros

summarizeBy

ExcelScript.AggregationFunction

Retornos

void

Exemplos

/**
 * This script changes how the data in a PivotTable is aggregated.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first PivotTable in the workbook.
  const pivotTable = workbook.getPivotTables()[0];
  
  // Set the first data hierarchy to summarize with an average value, instead of a sum.
  const dataHierarchy = pivotTable.getDataHierarchies()[0];
  dataHierarchy.setSummarizeBy(ExcelScript.AggregationFunction.average);
}

setToDefault()

Redefina a DataPivotHierarchy para os valores padrão.

setToDefault(): void;

Retornos

void