ExcelScript.RowColumnPivotHierarchy interface

Пакет:

ExcelScript

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

Замечания

Примеры

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

Методика

getFields()	Возвращает сводные поля, связанные с RowColumnPivotHierarchy.
getId()	Идентификатор RowColumnPivotHierarchy.
getName()	Имя RowColumnPivotHierarchy.
getPivotField(name)	Возвращает сводное поле по имени. Если сводное поле не существует, этот метод возвращает undefined.
getPosition()	Положение RowColumnPivotHierarchy.
setName(name)	Имя RowColumnPivotHierarchy.
setPosition(position)	Положение RowColumnPivotHierarchy.
setToDefault()	Сбрасывает RowColumnPivotHierarchy до значений по умолчанию.

Подробнее о методе

getFields()

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

getFields(): PivotField[];

Возвращает

ExcelScript.PivotField[]

getId()

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

getId(): string;

Возвращает

string

getName()

Имя RowColumnPivotHierarchy.

getName(): string;

Возвращает

string

getPivotField(name)

Возвращает сводное поле по имени. Если сводное поле не существует, этот метод возвращает undefined.

getPivotField(name: string): PivotField | undefined;

Параметры

name

string

Имя извлекаемого сводного поля.

Возвращает

ExcelScript.PivotField | undefined

getPosition()

Положение RowColumnPivotHierarchy.

getPosition(): number;

Возвращает

number

setName(name)

Имя RowColumnPivotHierarchy.

setName(name: string): void;

Параметры

name

string

Возвращает

void

setPosition(position)

Положение RowColumnPivotHierarchy.

setPosition(position: number): void;

Параметры

position

number

Возвращает

void

setToDefault()

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

setToDefault(): void;

Возвращает

void