deleteRowsByConditional

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

Chaque ligne est jugée sur la feuille telle qu'elle a été lue, puis les suppressions se font de bas en haut par blocs consécutifs. C'est ce qui évite l'erreur d'une boucle écrite à la main qui supprime les mauvaises lignes dès que les positions se décalent.

Les lignes disparaissent pour de bon : clearRowsByConditional se contente de les vider.

Une feuille désigne toute sa plage de données, et des lignes entières sont supprimées. Une plage ne désigne que ses cellules : elles sont supprimées, celles du dessous remontent, et les colonnes voisines restent en place. Dans les deux cas, le prédicat reçoit la position dans la feuille ; le refus de vider une feuille concerne la forme avec feuille, où une ligne doit subsister.

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 supprimé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();

deleteRowsByConditional(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 move up.
deleteRowsByConditional(sheet.getRange("B2:D100"), (values) => values.every((cell) => cell === ""));

Voir aussi

Code source

src/appsscript/sheet/deleteRowsByConditional.ts

23 September 2026

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