ExcelScript.RowColumnPivotHierarchy interface

Pacote:

ExcelScript

Representa o Excel RowColumnPivotHierarchy.

Comentários

Exemplos

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

getFields()	Retorna PivotFields associados a RowColumnPivotHierarchy.
getId()	ID do RowColumnPivotHierarchy.
getName()	Nome da RowColumnPivotHierarchy.
getPivotField(name)	Obtém um PivotField pelo nome. Se o PivotField não existir, esse método retornará undefined.
getPosition()	Posição da RowColumnPivotHierarchy.
setName(name)	Nome da RowColumnPivotHierarchy.
setPosition(position)	Posição da RowColumnPivotHierarchy.
setToDefault()	Redefine o RowColumnPivotHierarchy para os valores padrão.

Detalhes do método

getFields()

Retorna PivotFields associados a RowColumnPivotHierarchy.

getFields(): PivotField[];

Retornos

ExcelScript.PivotField[]

getId()

ID do RowColumnPivotHierarchy.

getId(): string;

Retornos

string

getName()

Nome da RowColumnPivotHierarchy.

getName(): string;

Retornos

string

getPivotField(name)

Obtém um PivotField pelo nome. Se o PivotField não existir, esse método retornará undefined.

getPivotField(name: string): PivotField | undefined;

Parâmetros

name

string

Nome do PivotField a ser recuperado.

Retornos

ExcelScript.PivotField | undefined

getPosition()

Posição da RowColumnPivotHierarchy.

getPosition(): number;

Retornos

number

setName(name)

Nome da RowColumnPivotHierarchy.

setName(name: string): void;

Parâmetros

name

string

Retornos

void

setPosition(position)

Posição da RowColumnPivotHierarchy.

setPosition(position: number): void;

Parâmetros

position

number

Retornos

void

setToDefault()

Redefine o RowColumnPivotHierarchy para os valores padrão.

setToDefault(): void;

Retornos

void