Compartilhar via

Excel.PivotLabelFilter interface

Pacote:
excel

Modelo configurável para um filtro de etiqueta 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

[ Conjunto de API: ExcelApi 1.12 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml

await Excel.run(async (context) => {
  // Add a PivotFilter to filter based on the strings of item labels.

  // Get the PivotTable.
  const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");

  // Get the "Type" field.
  const field = pivotTable.hierarchies.getItem("Type").fields.getItem("Type");

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

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

  await context.sync();
});

Propriedades

comparator

O comparador é o valor estático ao qual são comparados outros valores. O tipo de comparação é definido pela condição. Nota: uma cadeia numérica é tratada como um número quando é comparada com outras cadeias numéricas.
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. Nota: uma cadeia numérica é tratada como um número quando é comparada com outras cadeias numéricas.
substring

A subcadeia utilizada para as beginsWithcondições de filtro , endsWithe contains .
upperBound

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

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. Nota: uma cadeia numérica é tratada como um número quando é comparada com outras cadeias numéricas.

comparator?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

condition

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

condition: Excel.LabelFilterCondition | "Unknown" | "Equals" | "BeginsWith" | "EndsWith" | "Contains" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between";

Valor da propriedade

Excel.LabelFilterCondition | "Unknown" | "Equals" | "BeginsWith" | "EndsWith" | "Contains" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between"

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

lowerBound

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

lowerBound?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

substring

A subcadeia utilizada para as beginsWithcondições de filtro , endsWithe contains .

substring?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

upperBound

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

upperBound?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.12 ]