Compartilhar via


Excel.LabelFilterCondition enum

Enumeração que representa todas as condições aceites através das quais um filtro de etiqueta pode ser aplicado. Utilizado para configurar o tipo de PivotFilter aplicado ao campo. PivotFilter.criteria.exclusive pode ser definido como true para inverter muitas destas condições.

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

Campos

beginsWith = "BeginsWith"

A etiqueta começa com um critério de subcadeia.

Critérios Obrigatórios: {substring}. Critérios Opcionais: {exclusive}.

between = "Between"

Entre lowerBound critérios e upperBound .

Critérios Obrigatórios: {lowerBound, upperBound}. Critérios Opcionais: {exclusive}.

contains = "Contains"

A etiqueta contém um critério de subcadeia.

Critérios Obrigatórios: {substring}. Critérios Opcionais: {exclusive}.

endsWith = "EndsWith"

A etiqueta termina com critério de subcadeia.

Critérios Obrigatórios: {substring}. Critérios Opcionais: {exclusive}.

equals = "Equals"

É igual ao critério do comparador.

Critérios Obrigatórios: {comparator}. Critérios Opcionais: {exclusive}.

greaterThan = "GreaterThan"

Critério maior do que o comparador.

Critérios Obrigatórios: {comparator}.

greaterThanOrEqualTo = "GreaterThanOrEqualTo"

Maior ou igual ao critério do comparador.

Critérios Obrigatórios: {comparator}.

lessThan = "LessThan"

Menos do que o critério do comparador.

Critérios Obrigatórios: {comparator}.

lessThanOrEqualTo = "LessThanOrEqualTo"

Menor ou igual ao critério do comparador.

Critérios Obrigatórios: {comparator}.

unknown = "Unknown"

LabelFilterCondition é desconhecido ou não é suportado.