ExcelScript.PivotField interface

Pacote:

ExcelScript

Representa o Excel PivotField.

Métodos

applyFilter(filter)	Define um ou mais dos PivotFilters atuais do campo e aplica-os ao campo. Se os filtros fornecidos forem inválidos ou não puderem ser aplicados, uma exceção será gerada.
clearAllFilters()	Limpa todos os critérios de todos os filtros do campo. Isso remove qualquer filtragem ativa no campo.
clearFilter(filterType)	Limpa todos os critérios existentes do filtro do campo do tipo determinado (se um for aplicado no momento).
getFilters()	Obtém todos os filtros atualmente aplicados no campo.
getId()	ID do PivotField.
getItems()	Retorna os PivotItems associados ao PivotField.
getName()	Nome do PivotField.
getPivotItem(name)	Obtém um PivotItem pelo nome. Se o PivotItem não existir, esse método retornará undefined.
getShowAllItems()	Determina se deseja mostrar todos os itens de PivotField.
getSubtotals()	Subtotais de PivotField.
isFiltered(filterType)	Verifica se há 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 escopo define quais valores específicos serão usados para classificar quando houver vários valores da mesma DataPivotHierarchy.

Detalhes do método

applyFilter(filter)

Define um ou mais dos PivotFilters atuais do campo e aplica-os ao campo. Se os filtros fornecidos forem inválidos ou não puderem ser aplicados, uma exceção será gerada.

applyFilter(filter: PivotFilters): void;

Parâmetros

filter

ExcelScript.PivotFilters

Um PivotFilter específico configurado ou uma interface PivotFilters contendo 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. Isso remove qualquer filtragem ativa no campo.

clearAllFilters(): void;

Retornos

void

clearFilter(filterType)

Limpa todos os critérios existentes do filtro do campo do tipo determinado (se um for aplicado no momento).

clearFilter(filterType: PivotFilterType): void;

Parâmetros

filterType

ExcelScript.PivotFilterType

O tipo de filtro no campo do qual 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 PivotField.

getId(): string;

Retornos

string

getItems()

Retorna os PivotItems associados ao PivotField.

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, esse método retornará undefined.

getPivotItem(name: string): PivotItem | undefined;

Parâmetros

name

string

Nome do PivotItem a ser recuperado.

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 há filtros aplicados no campo.

isFiltered(filterType?: PivotFilterType): boolean;

Parâmetros

filterType

ExcelScript.PivotFilterType

O tipo de filtro a ser marcar. Se nenhum tipo for fornecido, esse método marcar se algum filtro for aplicado.

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 classificação é feita em ordem crescente ou decrescente.

Retornos

void

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

Classifica o Campo dinâmico por valores especificados em um determinado escopo. O escopo define quais valores específicos serão usados para classificar quando houver vários valores da mesma DataPivotHierarchy.

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

Parâmetros

sortBy

ExcelScript.SortBy

Especifica se a classificação é feita em ordem crescente ou decrescente.

valuesHierarchy

ExcelScript.DataPivotHierarchy

Especifica a hierarquia de valores no eixo de dados a ser usado para classificação.

pivotItemScope

Array<ExcelScript.PivotItem | string>

Os itens que devem ser usados para o escopo da classificação. Estes serão os itens que compõem a linha ou coluna que você deseja classificar. Se uma cadeia de caracteres for usada em vez de um PivotItem, a cadeia de caracteres representará a ID do PivotItem. Se não houver outros itens além da hierarquia de dados no eixo em que você deseja classificar, isso poderá 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);
}