Excel.PivotLabelFilter interface

Konfigurierbare Vorlage für einen Beschriftungsfilter, der auf ein PivotField angewendet werden kann. Das condition definiert, welche Kriterien festgelegt werden müssen, damit der Filter funktioniert.

Hinweise

API-Satz: ExcelApi 1.12

Verwendet von

Beispiele

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

Eigenschaften

comparator

Der Komparator ist der statische Wert, mit dem andere Werte verglichen werden. Die Art des Vergleichs wird durch die Bedingung definiert. Hinweis: Eine numerische Zeichenfolge wird beim Vergleich mit anderen numerischen Zeichenfolgen wie eine Zahl behandelt.

condition

Gibt die Bedingung für den Filter an, die die erforderlichen Filterkriterien definiert.

exclusive

Wenn trueder Filter ausschließt, werden Elemente ausgeschlossen , die die Kriterien erfüllen. Der Standardwert ist false (filtern Sie nach Elementen, die die Kriterien erfüllen).

lowerBound

Die untere Grenze des Bereichs für die between Filterbedingung. Hinweis: Eine numerische Zeichenfolge wird beim Vergleich mit anderen numerischen Zeichenfolgen wie eine Zahl behandelt.

substring

Die Teilzeichenfolge,endsWith die für die beginsWith, und contains Filterbedingungen verwendet wird.

upperBound

Die Obergrenze des Bereichs für die between Filterbedingung. Hinweis: Eine numerische Zeichenfolge wird beim Vergleich mit anderen numerischen Zeichenfolgen wie eine Zahl behandelt.

Details zur Eigenschaft

comparator

Der Komparator ist der statische Wert, mit dem andere Werte verglichen werden. Die Art des Vergleichs wird durch die Bedingung definiert. Hinweis: Eine numerische Zeichenfolge wird beim Vergleich mit anderen numerischen Zeichenfolgen wie eine Zahl behandelt.

comparator?: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.12

condition

Gibt die Bedingung für den Filter an, die die erforderlichen Filterkriterien definiert.

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

Eigenschaftswert

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

Hinweise

API-Satz: ExcelApi 1.12

exclusive

Wenn trueder Filter ausschließt, werden Elemente ausgeschlossen , die die Kriterien erfüllen. Der Standardwert ist false (filtern Sie nach Elementen, die die Kriterien erfüllen).

exclusive?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.12

lowerBound

Die untere Grenze des Bereichs für die between Filterbedingung. Hinweis: Eine numerische Zeichenfolge wird beim Vergleich mit anderen numerischen Zeichenfolgen wie eine Zahl behandelt.

lowerBound?: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.12

substring

Die Teilzeichenfolge,endsWith die für die beginsWith, und contains Filterbedingungen verwendet wird.

substring?: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.12

upperBound

Die Obergrenze des Bereichs für die between Filterbedingung. Hinweis: Eine numerische Zeichenfolge wird beim Vergleich mit anderen numerischen Zeichenfolgen wie eine Zahl behandelt.

upperBound?: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.12