ExcelScript.DataPivotHierarchy interface

Paquete:

ExcelScript

Representa la dataPivotHierarchy de Excel.

Comentarios

Ejemplos

/**
 *  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()	Devuelve los PivotFields asociados con DataPivotHierarchy.
getId()	Identificador de DataPivotHierarchy.
getName()	Nombre de DataPivotHierarchy.
getNumberFormat()	Formato de número de DataPivotHierarchy.
getPosition()	Posición de la DataPivotHierarchy.
getShowAs()	Especifica si los datos deben mostrarse como un cálculo de resumen específico.
getSummarizeBy()	Especifica si se muestran todos los elementos de DataPivotHierarchy.
setName(name)	Nombre de DataPivotHierarchy.
setNumberFormat(numberFormat)	Formato de número de DataPivotHierarchy.
setPosition(position)	Posición de la DataPivotHierarchy.
setShowAs(showAs)	Especifica si los datos deben mostrarse como un cálculo de resumen específico.
setSummarizeBy(summarizeBy)	Especifica si se muestran todos los elementos de DataPivotHierarchy.
setToDefault()	Restablece DataPivotHierarchy a sus valores predeterminados.

Detalles del método

getField()

Devuelve los PivotFields asociados con DataPivotHierarchy.

getField(): PivotField;

Devoluciones

ExcelScript.PivotField

getId()

Identificador de DataPivotHierarchy.

getId(): string;

Devoluciones

string

getName()

Nombre de DataPivotHierarchy.

getName(): string;

Devoluciones

string

getNumberFormat()

Formato de número de DataPivotHierarchy.

getNumberFormat(): string;

Devoluciones

string

getPosition()

Posición de la DataPivotHierarchy.

getPosition(): number;

Devoluciones

number

getShowAs()

Especifica si los datos deben mostrarse como un cálculo de resumen específico.

getShowAs(): ShowAsRule;

Devoluciones

ExcelScript.ShowAsRule

getSummarizeBy()

Especifica si se muestran todos los elementos de DataPivotHierarchy.

getSummarizeBy(): AggregationFunction;

Devoluciones

ExcelScript.AggregationFunction

setName(name)

Nombre de DataPivotHierarchy.

setName(name: string): void;

Parámetros

name

string

Devoluciones

void

setNumberFormat(numberFormat)

Formato de número de DataPivotHierarchy.

setNumberFormat(numberFormat: string): void;

Parámetros

numberFormat

string

Devoluciones

void

setPosition(position)

Posición de la DataPivotHierarchy.

setPosition(position: number): void;

Parámetros

position

number

Devoluciones

void

setShowAs(showAs)

Especifica si los datos deben mostrarse como un cálculo de resumen específico.

setShowAs(showAs: ShowAsRule): void;

Parámetros

showAs

ExcelScript.ShowAsRule

Devoluciones

void

Ejemplos

/**
 * 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 si se muestran todos los elementos de DataPivotHierarchy.

setSummarizeBy(summarizeBy: AggregationFunction): void;

Parámetros

summarizeBy

ExcelScript.AggregationFunction

Devoluciones

void

Ejemplos

/**
 * 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()

Restablece DataPivotHierarchy a sus valores predeterminados.

setToDefault(): void;

Devoluciones

void