How do I select a range of cells?

Something like this would be nice:

worksheet.getRange('B1:E22')

but I don’t see anything like it in the readme.

Ultimately, I am trying to add a border around a range like so:

[kendallroth]

I’m fairly surprised that this hasn’t been a more commonly requested feature; is it something that we could see support for in the near future?

Here’s what I’ve come up with in the mean time, not quite fully error-proof (missing a few checks) but close enough:

/**
 * Select a range of cells
 * @param  {string}   startCell - Range start cell (top-left)
 * @param  {string}   endCell   - Range end cell (bottom-right)
 * @return {Object[]}           - Selected cells
 */
const selectRange = (sheet, startCell, endCell) => {
  const [endCellColumn, endRow] = endCell.split(":", 2);
  const [startCellColumn, startRow] = startCell.split(":", 2);

  let endColumn = sheet.getColumn(endCellColumn);
  let startColumn = sheet.getColumn(startCellColumn);

  if (!endColumn) throw new Error("End column not found");
  if (!startColumn) throw new Error("Start column not found");

  endColumn = endColumn._number;
  startColumn = startColumn._number;

  const cells = [];
  for (let y = startRow; y <= endRow; y++) {
    const row = sheet.getRow(y);

    for (let x = startColumn; x <= endColumn; x++) {
      cells.push(row.getCell(x));
    }
  }

  return cells;
};

Sample Usage

const lastRow = worksheet.lastRow._number;
const row = selectRange(worksheet, `startColumnKey:${lastRow}`,  `endColumnKey:${lastRow + 4}`);

row.forEach(cell => {
  // TODO: Do something with each cell
});

[JacobWeisenburger]

so…I’m guessing this is not a problem for anyone else… sigh