Partager via

ExcelScript.DataPivotHierarchy interface

  • Référence
Paquet:
ExcelScript

Représente la DataPivotHierarchy Excel.

Remarques

Exemples

/**
 *  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éthodes

getField()

Renvoie les PivotFields associés à la DataPivotHierarchy.
getId()

ID de dataPivotHierarchy.
getName()

Nom de la DataPivotHierarchy.
getNumberFormat()

Format de nombre de la DataPivotHierarchy.
getPosition()

Position de la DataPivotHierarchy.
getShowAs()

Spécifie si les données doivent être affichées sous la forme d’un calcul récapitulatif spécifique.
getSummarizeBy()

Spécifie si tous les éléments de DataPivotHierarchy sont affichés.
setName(name)

Nom de la DataPivotHierarchy.
setNumberFormat(numberFormat)

Format de nombre de la DataPivotHierarchy.
setPosition(position)

Position de la DataPivotHierarchy.
setShowAs(showAs)

Spécifie si les données doivent être affichées sous la forme d’un calcul récapitulatif spécifique.
setSummarizeBy(summarizeBy)

Spécifie si tous les éléments de DataPivotHierarchy sont affichés.
setToDefault()

Restaurer la DataPivotHierarchy à ses valeurs par défaut.

Détails de la méthode

getField()

Renvoie les PivotFields associés à la DataPivotHierarchy.

getField(): PivotField;

Retours

ExcelScript.PivotField

getId()

ID de dataPivotHierarchy.

getId(): string;

Retours

string

getName()

Nom de la DataPivotHierarchy.

getName(): string;

Retours

string

getNumberFormat()

Format de nombre de la DataPivotHierarchy.

getNumberFormat(): string;

Retours

string

getPosition()

Position de la DataPivotHierarchy.

getPosition(): number;

Retours

number

getShowAs()

Spécifie si les données doivent être affichées sous la forme d’un calcul récapitulatif spécifique.

getShowAs(): ShowAsRule;

Retours

ExcelScript.ShowAsRule

getSummarizeBy()

Spécifie si tous les éléments de DataPivotHierarchy sont affichés.

getSummarizeBy(): AggregationFunction;

Retours

ExcelScript.AggregationFunction

setName(name)

Nom de la DataPivotHierarchy.

setName(name: string): void;

Paramètres

name

string

Retours

void

setNumberFormat(numberFormat)

Format de nombre de la DataPivotHierarchy.

setNumberFormat(numberFormat: string): void;

Paramètres

numberFormat

string

Retours

void

setPosition(position)

Position de la DataPivotHierarchy.

setPosition(position: number): void;

Paramètres

position

number

Retours

void

setShowAs(showAs)

Spécifie si les données doivent être affichées sous la forme d’un calcul récapitulatif spécifique.

setShowAs(showAs: ShowAsRule): void;

Paramètres

showAs
ExcelScript.ShowAsRule

Retours

void

Exemples

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

Spécifie si tous les éléments de DataPivotHierarchy sont affichés.

setSummarizeBy(summarizeBy: AggregationFunction): void;

Paramètres

summarizeBy
ExcelScript.AggregationFunction

Retours

void

Exemples

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

Restaurer la DataPivotHierarchy à ses valeurs par défaut.

setToDefault(): void;

Retours

void