ExcelScript.DataPivotHierarchy interface

Пакет:

ExcelScript

Представляет excel DataPivotHierarchy.

Комментарии

Примеры

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

Методы

getField()	Возвращает сводные поля, связанные с DataPivotHierarchy.
getId()	Идентификатор DataPivotHierarchy.
getName()	Имя DataPivotHierarchy.
getNumberFormat()	Числовой формат DataPivotHierarchy.
getPosition()	Положение DataPivotHierarchy.
getShowAs()	Указывает, должны ли данные отображаться в виде определенного суммарного вычисления.
getSummarizeBy()	Указывает, отображаются ли все элементы DataPivotHierarchy.
setName(name)	Имя DataPivotHierarchy.
setNumberFormat(numberFormat)	Числовой формат DataPivotHierarchy.
setPosition(position)	Положение DataPivotHierarchy.
setShowAs(showAs)	Указывает, должны ли данные отображаться в виде определенного суммарного вычисления.
setSummarizeBy(summarizeBy)	Указывает, отображаются ли все элементы DataPivotHierarchy.
setToDefault()	Сбрасывает DataPivotHierarchy до значений по умолчанию.

Сведения о методе

getField()

Возвращает сводные поля, связанные с DataPivotHierarchy.

getField(): PivotField;

Возвращаемое значение

ExcelScript.PivotField

getId()

Идентификатор DataPivotHierarchy.

getId(): string;

Возвращаемое значение

string

getName()

Имя DataPivotHierarchy.

getName(): string;

Возвращаемое значение

string

getNumberFormat()

Числовой формат DataPivotHierarchy.

getNumberFormat(): string;

Возвращаемое значение

string

getPosition()

Положение DataPivotHierarchy.

getPosition(): number;

Возвращаемое значение

number

getShowAs()

Указывает, должны ли данные отображаться в виде определенного суммарного вычисления.

getShowAs(): ShowAsRule;

Возвращаемое значение

ExcelScript.ShowAsRule

getSummarizeBy()

Указывает, отображаются ли все элементы DataPivotHierarchy.

getSummarizeBy(): AggregationFunction;

Возвращаемое значение

ExcelScript.AggregationFunction

setName(name)

Имя DataPivotHierarchy.

setName(name: string): void;

Параметры

name

string

Возвращаемое значение

void

setNumberFormat(numberFormat)

Числовой формат DataPivotHierarchy.

setNumberFormat(numberFormat: string): void;

Параметры

numberFormat

string

Возвращаемое значение

void

setPosition(position)

Положение DataPivotHierarchy.

setPosition(position: number): void;

Параметры

position

number

Возвращаемое значение

void

setShowAs(showAs)

Указывает, должны ли данные отображаться в виде определенного суммарного вычисления.

setShowAs(showAs: ShowAsRule): void;

Параметры

showAs

ExcelScript.ShowAsRule

Возвращаемое значение

void

Примеры

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

Указывает, отображаются ли все элементы DataPivotHierarchy.

setSummarizeBy(summarizeBy: AggregationFunction): void;

Параметры

summarizeBy

ExcelScript.AggregationFunction

Возвращаемое значение

void

Примеры

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

Сбрасывает DataPivotHierarchy до значений по умолчанию.

setToDefault(): void;

Возвращаемое значение

void