ExcelScript.PivotLabelFilter interface

Pacote:
ExcelScript

Modelo configurável para um filtro de rótulo a ser aplicado a um PivotField. O condition define quais critérios precisam ser definidos para que o filtro funcione.

Comentários

Usada por

Exemplos

/**
 * This script filters items that start with "L" from the "Type" field
 * of the "Farm Sales" PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable.
  const pivotTable = workbook.getActiveWorksheet().getPivotTable("Farm Sales");

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

  // Filter out any types that start with "L" (such as "Lemons" and "Limes").
  const filter: ExcelScript.PivotLabelFilter = {
    condition: ExcelScript.LabelFilterCondition.beginsWith,
    substring: "L",
    exclusive: true
  };

  // Apply the label filter to the field.
  field.applyFilter({ labelFilter: filter });
}

Propriedades

comparator

O comparador é o valor estático com o qual outros valores são comparados. O tipo de comparação é definido pela condição. Nota: Uma cadeia de caracteres numérica é tratada como um número ao ser comparada com outras cadeias de caracteres numéricas.
condition

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

Se true, o filtro exclui itens que atendem aos critérios. O padrão é false (filtrar para incluir itens que atendem aos critérios).
lowerBound

O limite inferior do intervalo para a between condição de filtro. Nota: Uma cadeia de caracteres numérica é tratada como um número ao ser comparada com outras cadeias de caracteres numéricas.
substring

A subcadeia de caracteres usada para as beginsWithcondições , endsWithe contains filter.
upperBound

O limite superior do intervalo para a between condição de filtro. Nota: Uma cadeia de caracteres numérica é tratada como um número ao ser comparada com outras cadeias de caracteres numéricas.

Detalhes da propriedade

comparator

O comparador é o valor estático com o qual outros valores são comparados. O tipo de comparação é definido pela condição. Nota: Uma cadeia de caracteres numérica é tratada como um número ao ser comparada com outras cadeias de caracteres numéricas.

comparator?: string;

Valor da propriedade

string

condition

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

condition: LabelFilterCondition;

Valor da propriedade

ExcelScript.LabelFilterCondition

exclusive

Se true, o filtro exclui itens que atendem aos critérios. O padrão é false (filtrar para incluir itens que atendem aos critérios).

exclusive?: boolean;

Valor da propriedade

boolean

lowerBound

O limite inferior do intervalo para a between condição de filtro. Nota: Uma cadeia de caracteres numérica é tratada como um número ao ser comparada com outras cadeias de caracteres numéricas.

lowerBound?: string;

Valor da propriedade

string

substring

A subcadeia de caracteres usada para as beginsWithcondições , endsWithe contains filter.

substring?: string;

Valor da propriedade

string

upperBound

O limite superior do intervalo para a between condição de filtro. Nota: Uma cadeia de caracteres numérica é tratada como um número ao ser comparada com outras cadeias de caracteres numéricas.

upperBound?: string;

Valor da propriedade

string