clearRowsByConditional

function clearRowsByConditional(
  target: GoogleAppsScript.Spreadsheet.Sheet | GoogleAppsScript.Spreadsheet.Range,
  predicate: RowPredicate,
  options: RowConditionalOptions | null | undefined = {}
): number;

Der Inhalt verschwindet, die Zeilen bleiben: die Positionen verschieben sich nicht, und alles, was eine Zeile über ihre Nummer anspricht, zeigt weiter auf dieselbe Stelle. Entfernt werden sie von deleteRowsByConditional.

Das Blatt wird einmal gelesen und das Leeren in zusammenhängende Blöcke gruppiert, sodass auch eine verstreute Auswahl wenige Dienstaufrufe kostet.

Ein Blatt meint seinen ganzen Datenbereich; ein Bereich meint nur die Zellen darin, der Rest des Blatts wird weder gelesen noch berührt. In beiden Fällen erhält das Prädikat die Position im Blatt, eine Zeile behält also ihre echte Nummer.

Parameter

Parameter	Typ	Beschreibung
`target`	`GoogleAppsScript.Spreadsheet.Sheet \\| GoogleAppsScript.Spreadsheet.Range`	Das Blatt, auf dem gearbeitet wird, oder der Bereich, innerhalb dessen gearbeitet wird: nur dessen Zellen werden gelesen, und nur sie werden geleert.
`predicate`	`RowPredicate`	Bekommt die Zellen der Zeile, ihre einsbasierte Position und — wenn `headerRow` gesetzt ist — die Zeile mit den Spaltennamen als Schlüsseln. `true` für die Zeilen, auf die gewirkt werden soll.
`options` (optional) `= {}`	`RowConditionalOptions \\| null \\| undefined`	`headerRow` benennt die Zeile mit den Spaltennamen. Ist sie gesetzt, kommt jede Zeile mit diesen Namen als Schlüsseln, und die Kopfzeile selbst scheidet als Kandidat aus.

Rückgabewert

number — wie viele betroffen waren.

Ausnahmen

Ausnahme	Bedingung
`InvalidSheetException`	das erste Argument weder ein Blatt noch ein Bereich ist.
`IllegalArgumentException`	das Prädikat ist keine Funktion oder die Kopfposition keine positive ganze Zahl.

Beispiele

Im Einsatz

const sheet = SpreadsheetApp.getActiveSheet();

clearRowsByConditional(sheet, (values, position, row) => row.status === "done", {
  headerRow: 1
});

Innerhalb eines Blocks

const sheet = SpreadsheetApp.getActiveSheet();

// Only B2:D100 is read, and only those cells are cleared.
clearRowsByConditional(sheet.getRange("B2:D100"), (values) => values.every((cell) => cell === ""));

Siehe auch

Quellcode

src/appsscript/sheet/clearRowsByConditional.ts

23 September 2026

Diese Dokumentation wurde mit KI (Claude) aus dem Quellcode der Bibliothek erzeugt.