Excel.AutoFilter class
Stellt das AutoFilter -Objekt dar. AutoFilter wandelt die Werte in der Excel-Spalte basierend auf dem Zellinhalt in bestimmte Filter um.
- Extends
Hinweise
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| criteria | Ein Array, das alle Filterkriterien in dem per AutoFilter gefilterten Bereich enthält. |
| enabled | Gibt an, ob autoFilter aktiviert ist. |
| is |
Gibt an, ob der AutoFilter Über Filterkriterien verfügt. |
Methoden
| apply(range, column |
Wendet den AutoFilter auf einen Bereich an. Dies filtert die Spalte, wenn Spaltenindex und Filterkriterien angegeben sind. |
| clear |
Löscht die Spaltenfilterkriterien des AutoFilters. |
| clear |
Löscht die Filterkriterien und den Sortierstatus des AutoFilters. |
| get |
Gibt das |
| get |
Gibt das |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| reapply() | Wendet das angegebene AutoFilter-Objekt an, das sich derzeit im Bereich befindet. |
| remove() | Entfernt den AutoFilter für den Bereich. |
| toJSON() | Überschreibt die JavaScript-Methode |
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
criteria
Ein Array, das alle Filterkriterien in dem per AutoFilter gefilterten Bereich enthält.
readonly criteria: Excel.FilterCriteria[];Eigenschaftswert
Hinweise
enabled
Gibt an, ob autoFilter aktiviert ist.
readonly enabled: boolean;Eigenschaftswert
boolean
Hinweise
isDataFiltered
Gibt an, ob der AutoFilter Über Filterkriterien verfügt.
readonly isDataFiltered: boolean;Eigenschaftswert
boolean
Hinweise
Details zur Methode
apply(range, columnIndex, criteria)
Wendet den AutoFilter auf einen Bereich an. Dies filtert die Spalte, wenn Spaltenindex und Filterkriterien angegeben sind.
apply(range: Range | string, columnIndex?: number, criteria?: Excel.FilterCriteria): void;Parameter
- range
-
Excel.Range | string
Der Bereich, auf den der AutoFilter angewendet wird.
- columnIndex
-
number
Der nullbasierte Spaltenindex, auf den der AutoFilter angewendet wird.
- criteria
- Excel.FilterCriteria
Die Filterkriterien.
Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml
// This function adds a percentage AutoFilter to the active worksheet
// and applies the filter to a column of the used range.
await Excel.run(async (context) => {
// Retrieve the active worksheet and the used range on that worksheet.
const sheet = context.workbook.worksheets.getActiveWorksheet();
const farmData = sheet.getUsedRange();
// Add a filter that will only show the rows with the top 50% of values in column 3.
sheet.autoFilter.apply(farmData, 3, {
criterion1: "50",
filterOn: Excel.FilterOn.topPercent
});
await context.sync();
});
clearColumnCriteria(columnIndex)
Löscht die Spaltenfilterkriterien des AutoFilters.
clearColumnCriteria(columnIndex: number): void;Parameter
- columnIndex
-
number
Der nullbasierte Spaltenindex, der angibt, welcher Spaltenfilter gelöscht werden muss. Wenn der Indexwert nicht unterstützt wird (z. B. wenn der Wert eine negative Zahl ist oder wenn der Wert größer als die Anzahl der verfügbaren Spalten im Bereich ist), wird ein InvalidArgument Fehler ausgelöst.
Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml
// This function clears the AutoFilter setting from one column.
await Excel.run(async (context) => {
// Retrieve the active worksheet.
const sheet = context.workbook.worksheets.getActiveWorksheet();
// Clear the filter from only column 3.
sheet.autoFilter.clearColumnCriteria(3);
await context.sync();
});
clearCriteria()
Löscht die Filterkriterien und den Sortierstatus des AutoFilters.
clearCriteria(): void;Gibt zurück
void
Hinweise
getRange()
Gibt das Range -Objekt zurück, das den Bereich darstellt, auf den der AutoFilter angewendet wird.
getRange(): Excel.Range;Gibt zurück
Hinweise
getRangeOrNullObject()
Gibt das Range -Objekt zurück, das den Bereich darstellt, auf den der AutoFilter angewendet wird. Wenn dem AutoFilter kein Range Objekt zugeordnet ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getRangeOrNullObject(): Excel.Range;Gibt zurück
Hinweise
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.AutoFilterLoadOptions): Excel.AutoFilter;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
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.AutoFilter;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
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.AutoFilter;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
reapply()
Wendet das angegebene AutoFilter-Objekt an, das sich derzeit im Bereich befindet.
reapply(): void;Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml
// This function refreshes the AutoFilter to ensure that changes are captured.
await Excel.run(async (context) => {
// Retrieve the active worksheet.
const sheet = context.workbook.worksheets.getActiveWorksheet();
// Reapply the filter to capture changes.
sheet.autoFilter.reapply();
await context.sync();
});
remove()
Entfernt den AutoFilter für den Bereich.
remove(): void;Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml
// This function removes all AutoFilters from the active worksheet.
await Excel.run(async (context) => {
// Retrieve the active worksheet.
const sheet = context.workbook.worksheets.getActiveWorksheet();
// Remove all filters.
sheet.autoFilter.remove();
await context.sync();
});
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.AutoFilter Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.AutoFilterData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.AutoFilterData;Gibt zurück
Office Add-ins