ExcelScript.RowColumnPivotHierarchy interface
Representa a RowColumnPivotHierarchy do Excel.
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
get |
Retorna PivotFields associados a RowColumnPivotHierarchy. |
get |
ID da RowColumnPivotHierarchy. |
get |
Nome da RowColumnPivotHierarchy. |
get |
Obtém um Campo Dinâmico pelo nome. Se o Campo Dinâmico não existir, este método devolve |
get |
Posição da RowColumnPivotHierarchy. |
set |
Nome da RowColumnPivotHierarchy. |
set |
Posição da RowColumnPivotHierarchy. |
set |
Redefine o RowColumnPivotHierarchy para os valores padrão. |
Detalhes do método
getFields()
Retorna PivotFields associados a RowColumnPivotHierarchy.
getFields(): PivotField[];
Retornos
getId()
ID da RowColumnPivotHierarchy.
getId(): string;
Retornos
string
getName()
Nome da RowColumnPivotHierarchy.
getName(): string;
Retornos
string
getPivotField(name)
Obtém um Campo Dinâmico pelo nome. Se o Campo Dinâmico não existir, este método devolve undefined
.
getPivotField(name: string): PivotField | undefined;
Parâmetros
- name
-
string
Nome do Campo Dinâmico a obter.
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