ExcelScript.PivotLabelFilter interface

Paket:

ExcelScript

Konfigurierbare Vorlage für einen Bezeichnungsfilter, der auf ein PivotField angewendet werden soll. Definiert condition , welche Kriterien festgelegt werden müssen, damit der Filter funktioniert.

Hinweise

Beispiele

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

Eigenschaften

comparator	Der Vergleichsparameter ist der statische Wert, mit dem andere Werte verglichen werden. Der Vergleichstyp wird durch die Bedingung definiert. Hinweis: Eine numerische Zeichenfolge wird als Zahl behandelt, wenn sie mit anderen numerischen Zeichenfolgen verglichen wird.
condition	Gibt die Bedingung für den Filter an, der die erforderlichen Filterkriterien definiert.
exclusive	Wenn true, schließt filter Elemente aus , die Kriterien erfüllen. Der Standardwert ist false (Filter, um Elemente einzuschließen, die Kriterien erfüllen).
lowerBound	Die untere Grenze des Bereichs für die between Filterbedingung. Hinweis: Eine numerische Zeichenfolge wird als Zahl behandelt, wenn sie mit anderen numerischen Zeichenfolgen verglichen wird.
substring	Die Teilzeichenfolge, die für die beginsWithFilterbedingungen , endsWithund contains verwendet wird.
upperBound	Die obere Grenze des Bereichs für die between Filterbedingung. Hinweis: Eine numerische Zeichenfolge wird als Zahl behandelt, wenn sie mit anderen numerischen Zeichenfolgen verglichen wird.

Details zur Eigenschaft

comparator

Der Vergleichsparameter ist der statische Wert, mit dem andere Werte verglichen werden. Der Vergleichstyp wird durch die Bedingung definiert. Hinweis: Eine numerische Zeichenfolge wird als Zahl behandelt, wenn sie mit anderen numerischen Zeichenfolgen verglichen wird.

comparator?: string;

Eigenschaftswert

string

condition

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

condition: LabelFilterCondition;

Eigenschaftswert

ExcelScript.LabelFilterCondition

exclusive

Wenn true, schließt filter Elemente aus , die Kriterien erfüllen. Der Standardwert ist false (Filter, um Elemente einzuschließen, die Kriterien erfüllen).

exclusive?: boolean;

Eigenschaftswert

boolean

lowerBound

Die untere Grenze des Bereichs für die between Filterbedingung. Hinweis: Eine numerische Zeichenfolge wird als Zahl behandelt, wenn sie mit anderen numerischen Zeichenfolgen verglichen wird.

lowerBound?: string;

Eigenschaftswert

string

substring

Die Teilzeichenfolge, die für die beginsWithFilterbedingungen , endsWithund contains verwendet wird.

substring?: string;

Eigenschaftswert

string

upperBound

Die obere Grenze des Bereichs für die between Filterbedingung. Hinweis: Eine numerische Zeichenfolge wird als Zahl behandelt, wenn sie mit anderen numerischen Zeichenfolgen verglichen wird.

upperBound?: string;

Eigenschaftswert

string