Excel.Filter class

Paket:

excel

Verwaltet das Filtern der Spalte einer Tabelle.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Eigenschaften

context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
criteria	Der aktuell angewendete Filter in der angegebenen Spalte.

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.
applyCustomFilter(criteria1, criteria2, operString)	Wenden Sie einen "Symbol"-Filter auf die Spalte für die angegebenen Kriterienzeichenfolgen an.
applyDynamicFilter(criteria)	Wendet den Filter "Dynamic" auf die Spalte an.
applyDynamicFilter(criteriaString)	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.
load(options)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
toJSON()	Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.Filter Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.FilterData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

criteria

Der aktuell angewendete Filter in der angegebenen Spalte.

readonly criteria: Excel.FilterCriteria;

Eigenschaftswert

Excel.FilterCriteria

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Details zur Methode

apply(criteria)

Wendet die angegebenen Filterkriterien in der angegebenen Spalte an.

apply(criteria: Excel.FilterCriteria): void;

Parameter

criteria

Excel.FilterCriteria

Die Kriterien, die angewendet werden sollen.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.2 ]

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

Hinweise

[ API-Satz: ExcelApi 1.2 ]

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

Hinweise

[ API-Satz: ExcelApi 1.2 ]

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

Hinweise

[ API-Satz: ExcelApi 1.2 ]

applyCustomFilter(criteria1, criteria2, oper)

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

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

Parameter

criteria1

string

Die erste Kriterienzeichenfolge.

criteria2

string

Optional. Die zweite Kriterienzeichenfolge.

oper

Excel.FilterOperator

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

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.2 ]

applyCustomFilter(criteria1, criteria2, operString)

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

applyCustomFilter(criteria1: string, criteria2?: string, operString?: "And" | "Or"): void;

Parameter

criteria1

string

Die erste Kriterienzeichenfolge.

criteria2

string

Optional. Die zweite Kriterienzeichenfolge.

operString

"And" | "Or"

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

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.2 ]

applyDynamicFilter(criteria)

Wendet den Filter "Dynamic" auf die Spalte an.

applyDynamicFilter(criteria: Excel.DynamicFilterCriteria): void;

Parameter

criteria

Excel.DynamicFilterCriteria

Die dynamischen Kriterien, die angewendet werden sollen.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.2 ]

applyDynamicFilter(criteriaString)

Wendet den Filter "Dynamic" auf die Spalte an.

applyDynamicFilter(criteriaString: "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"): void;

Parameter

criteriaString

"Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"

Die dynamischen Kriterien, die angewendet werden sollen.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.2 ]

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

Hinweise

[ API-Satz: ExcelApi 1.2 ]

applyIconFilter(icon)

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

applyIconFilter(icon: Excel.Icon): void;

Parameter

icon

Excel.Icon

Die Symbole der Zellen, die angezeigt werden sollen.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.2 ]

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

Hinweise

[ API-Satz: ExcelApi 1.2 ]

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

Hinweise

[ API-Satz: ExcelApi 1.2 ]

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 | Excel.FilterDatetime>

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

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.2 ]

clear()

Deaktiviert den Filter für die angegebene Spalte.

clear(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.2 ]

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.FilterLoadOptions): Excel.Filter;

Parameter

options

Excel.Interfaces.FilterLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Excel.Filter

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Excel.Filter;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Excel.Filter

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Filter;

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.Filter

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.Filter Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.FilterData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.FilterData;

Gibt zurück

Excel.Interfaces.FilterData