ExcelScript.Filter interface

Paket:

ExcelScript

Verwaltet das Filtern der Spalte einer Tabelle.

Hinweise

Beispiele

/**
 * This script adds a table filter to only show the top 10% of values 
 * belonging to a particular column.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the first table on the current worksheet.
    const table = workbook.getActiveWorksheet().getTables()[0];

    // Get the filter for the "PageViews" table column.
    const pageViewFilter : ExcelScript.Filter = table.getColumnByName("PageViews").getFilter();

    // Apply a filter to only show the rows with the top 10% of values in this column.
    pageViewFilter.applyTopPercentFilter(10);
}

Methoden

apply(criteria)	Wendet die angegebenen Filterkriterien in der angegebenen Spalte an.
applyBottomItemsFilter(count)	Wendet den Filter "Bottom Item" auf die Spalte für die angegebene Anzahl von Elementen an.
applyBottomPercentFilter(percent)	Wendet den Filter "Bottom Percent" auf die Spalte für den angegebenen Prozentsatz von Elementen an.
applyCellColorFilter(color)	Wendet den Filter "Cell Color" auf die Spalte für die angegebene Farbe an.
applyCustomFilter(criteria1, criteria2, oper)	Wenden Sie einen "Symbol"-Filter auf die Spalte für die angegebenen Kriterienzeichenfolgen an.
applyDynamicFilter(criteria)	Wendet den Filter "Dynamic" auf die Spalte an.
applyFontColorFilter(color)	Wendet den Filter "Font Color" auf die Spalte für die angegebene Farbe an.
applyIconFilter(icon)	Wenden Sie einen "Symbol"-Filter auf die Spalte für das angegebene Symbol an.
applyTopItemsFilter(count)	Wendet den Filter „Top Item“ auf die Spalte für die angegebene Anzahl von Elementen an.
applyTopPercentFilter(percent)	Wendet den Filter "Top Percent" auf die Spalte für den angegebenen Prozentsatz von Elementen an.
applyValuesFilter(values)	Wendet den Filter "Values" auf die Spalte für die angegebenen Werte an.
clear()	Deaktiviert den Filter für die angegebene Spalte.
getCriteria()	Der aktuell angewendete Filter in der angegebenen Spalte.

Details zur Methode

apply(criteria)

Wendet die angegebenen Filterkriterien in der angegebenen Spalte an.

apply(criteria: FilterCriteria): void;

Parameter

criteria

ExcelScript.FilterCriteria

Die Kriterien, die angewendet werden sollen.

Gibt zurück

void

applyBottomItemsFilter(count)

Wendet den Filter "Bottom Item" auf die Spalte für die angegebene Anzahl von Elementen an.

applyBottomItemsFilter(count: number): void;

Parameter

count

number

Die Anzahl der Elemente vom unteren Rand, die angezeigt werden sollen.

Gibt zurück

void

applyBottomPercentFilter(percent)

Wendet den Filter "Bottom Percent" auf die Spalte für den angegebenen Prozentsatz von Elementen an.

applyBottomPercentFilter(percent: number): void;

Parameter

percent

number

Der Prozentsatz von Elementen vom unteren Rand, die angezeigt werden sollen.

Gibt zurück

void

applyCellColorFilter(color)

Wendet den Filter "Cell Color" auf die Spalte für die angegebene Farbe an.

applyCellColorFilter(color: string): void;

Parameter

color

string

Die Hintergrundfarbe der Zellen, die angezeigt werden sollen.

Gibt zurück

void

applyCustomFilter(criteria1, criteria2, oper)

Wenden Sie einen "Symbol"-Filter auf die Spalte für die angegebenen Kriterienzeichenfolgen an.

applyCustomFilter(
            criteria1: string,
            criteria2?: string,
            oper?: FilterOperator
        ): void;

Parameter

criteria1

string

Die erste Kriterienzeichenfolge.

criteria2

string

Optional. Die zweite Kriterienzeichenfolge.

oper

ExcelScript.FilterOperator

Optional. Der Operator, der beschreibt, wie die beiden Kriterien miteinander verknüpft sind.

Gibt zurück

void

Beispiele

/**
 * The script filters rows from a table based on numerical values.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const table = currentSheet.getTables()[0];

  // Filter to only show rows with values in the "Sales" column that are 
  // greater than or equal to 2000.
  table.getColumnByName("Sales").getFilter().applyCustomFilter(">=2000");
}

applyDynamicFilter(criteria)

Wendet den Filter "Dynamic" auf die Spalte an.

applyDynamicFilter(criteria: DynamicFilterCriteria): void;

Parameter

criteria

ExcelScript.DynamicFilterCriteria

Die dynamischen Kriterien, die angewendet werden sollen.

Gibt zurück

void

Beispiele

/**
 * This script applies a filter to a table that filters it 
 * to only show rows with dates from the previous month.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the table named "ReportTable".
  const table = workbook.getTable("ReportTable");

  // Get the column with the header "Date".
  const dateColumn = table.getColumnByName("Date");

  // Apply a dynamic filter to the column. 
  // `lastMonth` will only show rows with a date from the previous month.
  dateColumn.getFilter().applyDynamicFilter(ExcelScript.DynamicFilterCriteria.lastMonth);
}

applyFontColorFilter(color)

Wendet den Filter "Font Color" auf die Spalte für die angegebene Farbe an.

applyFontColorFilter(color: string): void;

Parameter

color

string

Die Schriftfarbe der Zellen, die angezeigt werden sollen.

Gibt zurück

void

applyIconFilter(icon)

Wenden Sie einen "Symbol"-Filter auf die Spalte für das angegebene Symbol an.

applyIconFilter(icon: Icon): void;

Parameter

icon

ExcelScript.Icon

Die Symbole der Zellen, die angezeigt werden sollen.

Gibt zurück

void

applyTopItemsFilter(count)

Wendet den Filter „Top Item“ auf die Spalte für die angegebene Anzahl von Elementen an.

applyTopItemsFilter(count: number): void;

Parameter

count

number

Die Anzahl der Elemente vom oberen Rand, die angezeigt werden sollen.

Gibt zurück

void

applyTopPercentFilter(percent)

Wendet den Filter "Top Percent" auf die Spalte für den angegebenen Prozentsatz von Elementen an.

applyTopPercentFilter(percent: number): void;

Parameter

percent

number

Der Prozentsatz von Elementen vom oberen Rand, die angezeigt werden sollen.

Gibt zurück

void

applyValuesFilter(values)

Wendet den Filter "Values" auf die Spalte für die angegebenen Werte an.

applyValuesFilter(values: Array<string | FilterDatetime>): void;

Parameter

values

Array<string | ExcelScript.FilterDatetime>

Die Liste der anzuzeigenden Werte. Dies muss ein Array von Zeichenfolgen oder ein Array von ExcelScript.FilterDateTime Objekten sein.

Gibt zurück

void

Beispiele

/**
 * This script applies a filter to a table so that it only shows rows with "Needs Review" in the "Type" column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  const table = workbook.getTables()[0];

  // Apply the filter to the "Type" column.
  const typeColumn = table.getColumnByName("Type");
  typeColumn.getFilter().applyValuesFilter(["Needs Review"]);
}

clear()

Deaktiviert den Filter für die angegebene Spalte.

clear(): void;

Gibt zurück

void

Beispiele

/**
 * This script shows how to clear a filter from a table column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  const table = workbook.getTables()[0];

  // Clear the filter for the table column named "Status".
  const statusColumnFilter = table.getColumn("Status").getFilter();
  statusColumnFilter.clear();
}

getCriteria()

Der aktuell angewendete Filter in der angegebenen Spalte.

getCriteria(): FilterCriteria;

Gibt zurück

ExcelScript.FilterCriteria