Skip to content

API reference / Common / Engine types / WorksheetCommand

Type Alias: WorksheetCommand ​

ts
type WorksheetCommand = 
  | {
  resizeColumns: {
     first: number;
     last: number;
     width: GridColumnWidth | null;
  };
}
  | {
  resizeRows: {
     first: number;
     last: number;
     height: GridRowHeight | null;
  };
}
  | {
  setCells: {
     cells: GridCellWrite[];
  };
};

An edit intent on one worksheet's grid — the sheet is the EditWorksheet wrapping it. A command naming a sheet that isn't a worksheet is a no-op.

A resize is a multi-track intent: the command carries an inclusive track range and fans out, at decode, into one absolute per-track WorksheetOperation — the command-does-many / operation-does-one split (like portable's command over its Set* operations). Each command commits once, so the whole command is one undo step.