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 相关联的 PivotFields。
getId()	RowColumnPivotHierarchy 的 ID。
getName()	RowColumnPivotHierarchy 的名称。
getPivotField(name)	按名称获取透视字段。 如果 PivotField 不存在，则此方法返回 undefined。
getPosition()	RowColumnPivotHierarchy 的位置。
setName(name)	RowColumnPivotHierarchy 的名称。
setPosition(position)	RowColumnPivotHierarchy 的位置。
setToDefault()	将 RowColumnPivotHierarchy 重置回其默认值。

方法详细信息

getFields()

返回与 RowColumnPivotHierarchy 相关联的 PivotFields。

getFields(): PivotField[];

返回

ExcelScript.PivotField[]

getId()

RowColumnPivotHierarchy 的 ID。

getId(): string;

返回

string

getName()

RowColumnPivotHierarchy 的名称。

getName(): string;

返回

string

getPivotField(name)

按名称获取透视字段。 如果 PivotField 不存在，则此方法返回 undefined。

getPivotField(name: string): PivotField | undefined;

参数

name

string

要检索的 PivotField 的名称。

返回

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