ExcelScript.PivotValueFilter interface

Pacote:

ExcelScript

Modelo configurável para um filtro de valor aplicar a um Campo Dinâmico. Define condition quais os critérios que têm de ser definidos para que o filtro funcione.

Comentários

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
  });
}

Propriedades

comparator	O comparador é o valor estático ao qual são comparados outros valores. O tipo de comparação é definido pela condição. Por exemplo, se o comparador for "50" e a condição for "greaterThan", todos os valores de itens que não sejam superiores a 50 serão removidos pelo filtro.
condition	Especifica a condição para o filtro, que define os critérios de filtragem necessários.
exclusive	Se true, o filtro excluirá os itens que cumprem os critérios. A predefinição é false (filtrar para incluir itens que cumprem os critérios).
lowerBound	O limite inferior do intervalo para a condição de between filtro.
selectionType	Especifica se o filtro se destina aos itens N superiores/inferiores, percentagem N superior/inferior ou soma N superior/inferior.
threshold	O número de limiar "N" de itens, percentagem ou soma a filtrar para uma condição de filtro superior/inferior.
upperBound	O limite superior do intervalo para a condição de between filtro.
value	Nome do "valor" escolhido no campo pelo qual filtrar.

Detalhes da propriedade

comparator

O comparador é o valor estático ao qual são comparados outros valores. O tipo de comparação é definido pela condição. Por exemplo, se o comparador for "50" e a condição for "greaterThan", todos os valores de itens que não sejam superiores a 50 serão removidos pelo filtro.

comparator?: number;

Valor da propriedade

number

condition

Especifica a condição para o filtro, que define os critérios de filtragem necessários.

condition: ValueFilterCondition;

Valor da propriedade

ExcelScript.ValueFilterCondition

exclusive

Se true, o filtro excluirá os itens que cumprem os critérios. A predefinição é false (filtrar para incluir itens que cumprem os critérios).

exclusive?: boolean;

Valor da propriedade

boolean

lowerBound

O limite inferior do intervalo para a condição de between filtro.

lowerBound?: number;

Valor da propriedade

number

selectionType

Especifica se o filtro se destina aos itens N superiores/inferiores, percentagem N superior/inferior ou soma N superior/inferior.

selectionType?: TopBottomSelectionType;

Valor da propriedade

ExcelScript.TopBottomSelectionType

threshold

O número de limiar "N" de itens, percentagem ou soma a filtrar para uma condição de filtro superior/inferior.

threshold?: number;

Valor da propriedade

number

upperBound

O limite superior do intervalo para a condição de between filtro.

upperBound?: number;

Valor da propriedade

number

value

Nome do "valor" escolhido no campo pelo qual filtrar.

value: string;

Valor da propriedade

string