Excel.PivotValueFilter interface

Konfigurierbare Vorlage für einen Wertfilter, der auf ein PivotField angewendet werden soll. 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 on the values correlated with a row.

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

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

  // Filter to only include rows with more than 500 wholesale crates sold.
  const filter: Excel.PivotValueFilter = {
    condition: Excel.ValueFilterCondition.greaterThan,
    comparator: 500,
    value: "Sum of Crates Sold Wholesale"
  };

  // Apply the value filter to the field.
  field.applyFilter({ valueFilter: 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. Wenn der Komparator beispielsweise "50" und die Bedingung "größer als" ist, werden alle Elementwerte, die nicht größer als 50 sind, vom Filter entfernt.

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.

selectionType

Gibt an, ob der Filter für die oberen/unteren N Elemente, die oberen/unteren N Prozent oder die obere/untere N-Summe gilt.

threshold

Der Schwellenwert "N" Anzahl der Elemente, Prozentsätze oder Summen, die für eine obere/untere Filterbedingung gefiltert werden sollen.

upperBound

Die Obergrenze des Bereichs für die between Filterbedingung.

value

Der Name des ausgewählten "Werts" im Feld, nach dem gefiltert werden soll.

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. Wenn der Komparator beispielsweise "50" und die Bedingung "größer als" ist, werden alle Elementwerte, die nicht größer als 50 sind, vom Filter entfernt.

comparator?: number;

Eigenschaftswert

number

Hinweise

API-Satz: ExcelApi 1.12

condition

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

condition: Excel.ValueFilterCondition | "Unknown" | "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN";

Eigenschaftswert

Excel.ValueFilterCondition | "Unknown" | "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN"

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.

lowerBound?: number;

Eigenschaftswert

number

Hinweise

API-Satz: ExcelApi 1.12

selectionType

Gibt an, ob der Filter für die oberen/unteren N Elemente, die oberen/unteren N Prozent oder die obere/untere N-Summe gilt.

selectionType?: Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum";

Eigenschaftswert

Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum"

Hinweise

API-Satz: ExcelApi 1.12

threshold

Der Schwellenwert "N" Anzahl der Elemente, Prozentsätze oder Summen, die für eine obere/untere Filterbedingung gefiltert werden sollen.

threshold?: number;

Eigenschaftswert

number

Hinweise

API-Satz: ExcelApi 1.12

upperBound

Die Obergrenze des Bereichs für die between Filterbedingung.

upperBound?: number;

Eigenschaftswert

number

Hinweise

API-Satz: ExcelApi 1.12

value

Der Name des ausgewählten "Werts" im Feld, nach dem gefiltert werden soll.

value: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.12