apps-script-utils 2.1.1 Help

isCellGridRange

function isCellGridRange(gridRange: GridRange): boolean;

One row and one column, measured by the bounds rather than by how the range was written: the end indices are exclusive, so a single cell is endRowIndex - startRowIndex === 1 and the same for the columns. A range with a bound left out is open in that direction and is never a single cell.

isX and nonX answer a question and never interrupt control flow; requireX and requireNonX hand the value back or throw. The scheme is explained in Validation conventions.

Parameters

Parameter

Type

Description

gridRange

GridRange

The GridRange object to check.

Returns

boolean — true when the value is a single-cell range; otherwise false.

Examples

What passes and what does not

isCellGridRange({ startRowIndex: 0, endRowIndex: 1, startColumnIndex: 0, endColumnIndex: 1 }); // => true isCellGridRange({ startRowIndex: 0, endRowIndex: 2, startColumnIndex: 0, endColumnIndex: 1 }); // => false isCellGridRange({}); // => false isCellGridRange(null); // => false

See also

Source

src/appsscript/sheet/isCellGridRange.ts

23 September 2026

This documentation was generated with AI (Claude) from the library's source code.