ExcelScript.DataPivotHierarchy interface

Paket:

ExcelScript

Stellt die Excel DataPivotHierarchy dar.

Hinweise

Beispiele

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

Methoden

getField()	Gibt die PivotFields-Objekte zurück, die dem DataPivotHierarchy-Objekt zugeordnet sind.
getId()	ID der DataPivotHierarchy.
getName()	Der Name des DataPivotHierarchy-Objekts.
getNumberFormat()	Das Zahlenformat des DataPivotHierarchy-Objekts.
getPosition()	Die Position des DataPivotHierarchy-Objekts.
getShowAs()	Gibt an, ob die Daten als eine bestimmte Zusammenfassungsberechnung angezeigt werden sollen.
getSummarizeBy()	Gibt an, ob alle Elemente der DataPivotHierarchy angezeigt werden.
setName(name)	Der Name des DataPivotHierarchy-Objekts.
setNumberFormat(numberFormat)	Das Zahlenformat des DataPivotHierarchy-Objekts.
setPosition(position)	Die Position des DataPivotHierarchy-Objekts.
setShowAs(showAs)	Gibt an, ob die Daten als eine bestimmte Zusammenfassungsberechnung angezeigt werden sollen.
setSummarizeBy(summarizeBy)	Gibt an, ob alle Elemente der DataPivotHierarchy angezeigt werden.
setToDefault()	Setzt das DataPivotHierarchy-Objekt auf die Standardwerte zurück.

Details zur Methode

getField()

Gibt die PivotFields-Objekte zurück, die dem DataPivotHierarchy-Objekt zugeordnet sind.

getField(): PivotField;

Gibt zurück

ExcelScript.PivotField

getId()

ID der DataPivotHierarchy.

getId(): string;

Gibt zurück

string

getName()

Der Name des DataPivotHierarchy-Objekts.

getName(): string;

Gibt zurück

string

getNumberFormat()

Das Zahlenformat des DataPivotHierarchy-Objekts.

getNumberFormat(): string;

Gibt zurück

string

getPosition()

Die Position des DataPivotHierarchy-Objekts.

getPosition(): number;

Gibt zurück

number

getShowAs()

Gibt an, ob die Daten als eine bestimmte Zusammenfassungsberechnung angezeigt werden sollen.

getShowAs(): ShowAsRule;

Gibt zurück

ExcelScript.ShowAsRule

getSummarizeBy()

Gibt an, ob alle Elemente der DataPivotHierarchy angezeigt werden.

getSummarizeBy(): AggregationFunction;

Gibt zurück

ExcelScript.AggregationFunction

setName(name)

Der Name des DataPivotHierarchy-Objekts.

setName(name: string): void;

Parameter

name

string

Gibt zurück

void

setNumberFormat(numberFormat)

Das Zahlenformat des DataPivotHierarchy-Objekts.

setNumberFormat(numberFormat: string): void;

Parameter

numberFormat

string

Gibt zurück

void

setPosition(position)

Die Position des DataPivotHierarchy-Objekts.

setPosition(position: number): void;

Parameter

position

number

Gibt zurück

void

setShowAs(showAs)

Gibt an, ob die Daten als eine bestimmte Zusammenfassungsberechnung angezeigt werden sollen.

setShowAs(showAs: ShowAsRule): void;

Parameter

showAs

ExcelScript.ShowAsRule

Gibt zurück

void

Beispiele

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

Gibt an, ob alle Elemente der DataPivotHierarchy angezeigt werden.

setSummarizeBy(summarizeBy: AggregationFunction): void;

Parameter

summarizeBy

ExcelScript.AggregationFunction

Gibt zurück

void

Beispiele

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

Setzt das DataPivotHierarchy-Objekt auf die Standardwerte zurück.

setToDefault(): void;

Gibt zurück

void