getFilter()

Beschreibung

Gibt ein Objekt mit den für die Datenfilterung festgelegten Kriterien zurück

Verwendung

getFilter(id?: string): {cell, rules};

Parameter

• id - (optional) die ID eines Tabellenblatts. Wenn nicht angegeben, wird die Methode für das aktuelle Tabellenblatt aufgerufen

Rückgabewert

Die Methode gibt ein Objekt mit Filterkriterien zurück. Das Objekt enthält zwei Attribute:

• cell - ein Zellenbereich, auf den die Filterung angewendet wird
• rules - ein Array von Objekten mit Regeln für die Filterung

Beispiel

const spreadsheet = new dhx.Spreadsheet("spreadsheet", {});
spreadsheet.parse(data);

// gibt die Filterkriterien für das aktuelle Tabellenblatt zurück
const filter = spreadsheet.getFilter(); // -> {cell:"A1:A8", rules: [{…}, {…}, {…}, {…}, {…}]}

Changelog: In v5.0 hinzugefügt

Verwandter Artikel: Daten filtern