ExcelScript.Filter interface

Verwaltet das Filtern der Spalte einer Tabelle.

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 "Icon"-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 "Icon"-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 "Icon"-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

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

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 "Icon"-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

clear()

Deaktiviert den Filter für die angegebene Spalte.

clear(): void;

Gibt zurück

void

getCriteria()

Der aktuell angewendete Filter in der angegebenen Spalte.

getCriteria(): FilterCriteria;

Gibt zurück