Compartilhar via

ExcelScript.PivotField interface

  • Referência
Pacote:
ExcelScript

Representa o Campo Dinâmico do Excel.

Métodos

applyFilter(filter)

Define um ou mais dos Filtros Dinâmicos atuais do campo e aplica-os ao campo. Se os filtros fornecidos forem inválidos ou não puderem ser aplicados, é emitida uma exceção.
clearAllFilters()

Limpa todos os critérios de todos os filtros do campo. Esta ação remove qualquer filtragem ativa no campo.
clearFilter(filterType)

Limpa todos os critérios existentes do filtro do campo do tipo especificado (se um estiver atualmente aplicado).
getFilters()

Obtém todos os filtros atualmente aplicados no campo.
getId()

ID do Campo Dinâmico.
getItems()

Devolve osItems Dinâmicos associados ao Campo Dinâmico.
getName()

Nome do PivotField.
getPivotItem(name)

Obtém um PivotItem pelo nome. Se o PivotItem não existir, este método devolve undefined.
getShowAllItems()

Determina se deseja mostrar todos os itens de PivotField.
getSubtotals()

Subtotais de PivotField.
isFiltered(filterType)

Verifica se existem filtros aplicados no campo.
setName(name)

Nome do PivotField.
setShowAllItems(showAllItems)

Determina se deseja mostrar todos os itens de PivotField.
setSubtotals(subtotals)

Subtotais de PivotField.
sortByLabels(sortBy)

Classifica o PivotField. Se um DataPivotHierarchy for especificado, a classificação será aplicada com base nele, se a classificação não for baseada no campo PivotField.
sortByValues(sortBy, valuesHierarchy, pivotItemScope)

Classifica o Campo dinâmico por valores especificados em um determinado escopo. O âmbito define os valores específicos que serão utilizados para ordenar quando existem múltiplos valores da mesma DataPivotHierarchy.

Detalhes do método

applyFilter(filter)

Define um ou mais dos Filtros Dinâmicos atuais do campo e aplica-os ao campo. Se os filtros fornecidos forem inválidos ou não puderem ser aplicados, é emitida uma exceção.

applyFilter(filter: PivotFilters): void;

Parâmetros

filter
ExcelScript.PivotFilters

Um PivotFilter específico configurado ou uma interface pivotFilters que contém vários filtros configurados.

Retornos

void

Exemplos

/**
 * This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable on the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let pivotTable = sheet.getPivotTables()[0];

  // Get the first row hierarchy to use as the field which gets filtered.
  let rowHierarchy = pivotTable.getRowHierarchies()[0];

  // Get the first data hierarchy to use as the values for filtering the rows.
  let dataHierarchy = pivotTable.getDataHierarchies()[0];

  // Create a filter that excludes values greater than 500.
  let filter: ExcelScript.PivotValueFilter = {
    condition: ExcelScript.ValueFilterCondition.greaterThan,
    comparator: 500,
    value: dataHierarchy.getName()
  };

  // Apply the filter.
  rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
    valueFilter: filter
  });
}

clearAllFilters()

Limpa todos os critérios de todos os filtros do campo. Esta ação remove qualquer filtragem ativa no campo.

clearAllFilters(): void;

Retornos

void

clearFilter(filterType)

Limpa todos os critérios existentes do filtro do campo do tipo especificado (se um estiver atualmente aplicado).

clearFilter(filterType: PivotFilterType): void;

Parâmetros

filterType
ExcelScript.PivotFilterType

O tipo de filtro no campo para limpar todos os critérios.

Retornos

void

Exemplos

/**
 * This script gets the "Type" field from the "Farms Sales" PivotTable 
 * and clears the value filter from it.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Sales".
  const pivot = workbook.getPivotTable("Farm Sales");

  // Get the "Type" field.
  const typeField = pivot.getHierarchy("Type").getPivotField("Type");

  // Clear the value filter (if there is one) from the field.
  typeField.clearFilter(ExcelScript.PivotFilterType.value);
}

getFilters()

Obtém todos os filtros atualmente aplicados no campo.

getFilters(): PivotFilters;

Retornos

ExcelScript.PivotFilters

getId()

ID do Campo Dinâmico.

getId(): string;

Retornos

string

getItems()

Devolve osItems Dinâmicos associados ao Campo Dinâmico.

getItems(): PivotItem[];

Retornos

ExcelScript.PivotItem[]

getName()

Nome do PivotField.

getName(): string;

Retornos

string

getPivotItem(name)

Obtém um PivotItem pelo nome. Se o PivotItem não existir, este método devolve undefined.

getPivotItem(name: string): PivotItem | undefined;

Parâmetros

name

string

Nome doItem Dinâmico a obter.

Retornos

ExcelScript.PivotItem | undefined

getShowAllItems()

Determina se deseja mostrar todos os itens de PivotField.

getShowAllItems(): boolean;

Retornos

boolean

getSubtotals()

Subtotais de PivotField.

getSubtotals(): Subtotals;

Retornos

ExcelScript.Subtotals

isFiltered(filterType)

Verifica se existem filtros aplicados no campo.

isFiltered(filterType?: PivotFilterType): boolean;

Parâmetros

filterType
ExcelScript.PivotFilterType

O tipo de filtro a marcar. Se não for fornecido nenhum tipo, este método marcar se for aplicado algum filtro.

Retornos

boolean

setName(name)

Nome do PivotField.

setName(name: string): void;

Parâmetros

name

string

Retornos

void

setShowAllItems(showAllItems)

Determina se deseja mostrar todos os itens de PivotField.

setShowAllItems(showAllItems: boolean): void;

Parâmetros

showAllItems

boolean

Retornos

void

setSubtotals(subtotals)

Subtotais de PivotField.

setSubtotals(subtotals: Subtotals): void;

Parâmetros

subtotals
ExcelScript.Subtotals

Retornos

void

sortByLabels(sortBy)

Classifica o PivotField. Se um DataPivotHierarchy for especificado, a classificação será aplicada com base nele, se a classificação não for baseada no campo PivotField.

sortByLabels(sortBy: SortBy): void;

Parâmetros

sortBy
ExcelScript.SortBy

Especifica se a ordenação é feita por ordem ascendente ou descendente.

Retornos

void

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

Classifica o Campo dinâmico por valores especificados em um determinado escopo. O âmbito define os valores específicos que serão utilizados para ordenar quando existem múltiplos valores da mesma DataPivotHierarchy.

sortByValues(
            sortBy: SortBy,
            valuesHierarchy: DataPivotHierarchy,
            pivotItemScope?: Array<PivotItem | string>
        ): void;

Parâmetros

sortBy
ExcelScript.SortBy

Especifica se a ordenação é feita por ordem ascendente ou descendente.

valuesHierarchy
ExcelScript.DataPivotHierarchy

Especifica a hierarquia de valores no eixo de dados a utilizar para ordenação.

pivotItemScope

Array<ExcelScript.PivotItem | string>

Os itens que devem ser utilizados para o âmbito da ordenação. Estes serão os itens que compõem a linha ou coluna que pretende ordenar. Se for utilizada uma cadeia em vez de um PivotItem, a cadeia representa o ID doItem Dinâmico. Se não existirem outros itens além da hierarquia de dados no eixo que pretende ordenar, isto pode estar vazio.

Retornos

void

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 = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");

  // Get the row to sort.
  const rowToSort = 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);
}