clearRowsByConditional

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

Le contenu part, les lignes restent : les positions ne bougent pas et tout ce qui désigne une ligne par son numéro continue de pointer au même endroit. C'est deleteRowsByConditional qui les supprime.

La feuille est lue une fois et l'effacement est regroupé en blocs consécutifs : une sélection dispersée coûte donc peu d'appels au service.

Une feuille désigne toute sa plage de données ; une plage ne désigne que les cellules qu'elle contient, le reste de la feuille n'étant ni lu ni touché. Dans les deux cas, le prédicat reçoit la position dans la feuille : une ligne garde son vrai numéro.

Paramètres

Paramètre	Type	Description
`target`	`GoogleAppsScript.Spreadsheet.Sheet \\| GoogleAppsScript.Spreadsheet.Range`	La feuille sur laquelle travailler, ou la plage dans laquelle travailler : seules ses cellules sont lues, et seules elles sont vidées.
`predicate`	`RowPredicate`	Reçoit les cellules de la ligne, sa position à base un et — si `headerRow` est défini — la ligne indexée par les noms de colonnes. Renvoyez `true` pour les lignes à traiter.
`options` (facultatif) `= {}`	`RowConditionalOptions \\| null \\| undefined`	`headerRow` désigne la ligne portant les noms de colonnes. Définie, elle indexe chaque ligne par ces noms et exclut la ligne d'en-tête des candidates.

Valeur de retour

number — combien ont été traitées.

Exceptions

Exception	Condition
`InvalidSheetException`	le premier argument n'est ni une feuille ni une plage.
`IllegalArgumentException`	le prédicat n'est pas une fonction, ou la position d'en-tête n'est pas un entier positif.

Exemples

Utilisation

const sheet = SpreadsheetApp.getActiveSheet();

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

Dans un seul bloc

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 === ""));

Voir aussi

Code source

src/appsscript/sheet/clearRowsByConditional.ts

23 September 2026

Cette documentation a été générée par une IA (Claude) à partir du code source de la bibliothèque.