Skip to content
Sheetwrite

Sheetwrite / Documentation

GridActions@sheetwrite/core

Imperative operations the toolbar and context menu bind to; also exposed as Grid.actions.
@sheetwrite/coreinterface

Imperative operations the toolbar and context menu bind to; also exposed as Grid.actions.

Package
@sheetwrite/core
Source
packages/core/src/types/grid.ts#L65

Members 34

toggleBold 
toggleBold(): void;
toggleItalic 
toggleItalic(): void;
toggleUnderline 
toggleUnderline(): void;
toggleStrikethrough 
toggleStrikethrough(): void;
setAlign 
setAlign(align: CellAlign): void;
setTextColor 
setTextColor(color: string): void;
setFillColor 
setFillColor(color: string): void;
toggleBorder 
toggleBorder(): void;
clearFormat 
clearFormat(): void;
merge 
merge(): void;
unmerge 
unmerge(): void;
sort 
sort(ascending: boolean): void;
insertRowAbove 
insertRowAbove(): void;
insertRowBelow 
insertRowBelow(): void;
deleteRow 
deleteRow(): void;
insertColumnLeft 
insertColumnLeft(): void;
insertColumnRight 
insertColumnRight(): void;
deleteColumn 
deleteColumn(): void;
hideRows 
hideRows(rows?: readonly number[]): void;
showRows 
showRows(rows?: readonly number[]): void;
autoFitRows 
autoFitRows(): void;
hideColumns 
hideColumns(cols?: readonly number[]): void;
showColumns 
showColumns(cols?: readonly number[]): void;
autoFitColumns 
autoFitColumns(cols?: readonly number[]): void;
clearFilter 
clearFilter(col?: number): void;
copy Copy the focused rectangle to the system clipboard. 
copy(): Promise<ClipboardOutcome>;

Copy the focused rectangle to the system clipboard. Never rejects.

cut Copy + clear the source (after the clipboard accepted). 
cut(): Promise<ClipboardOutcome>;

Copy + clear the source (after the clipboard accepted). Never rejects.

paste Paste at the focus cell. Never rejects. 
paste(): Promise<ClipboardOutcome>;
pasteValues Paste keeping only resolved values — no formulas, no styles (Ctrl+Shift+V). 
pasteValues(): Promise<ClipboardOutcome>;

Paste keeping only resolved values — no formulas, no styles (Ctrl+Shift+V). Never rejects.

clearContents 
clearContents(): void;
exportCsv 
exportCsv(filename?: string): void;
exportXlsx 
exportXlsx(filename?: string): void;
undo 
undo(): void;
redo 
redo(): void;

Declaration

View full TypeScript declaration 
export interface GridActions {
  toggleBold(): void;
  toggleItalic(): void;
  toggleUnderline(): void;
  toggleStrikethrough(): void;
  setAlign(align: CellAlign): void;
  setTextColor(color: string): void;
  setFillColor(color: string): void;
  toggleBorder(): void;
  clearFormat(): void;
  merge(): void;
  unmerge(): void;
  sort(ascending: boolean): void;
  insertRowAbove(): void;
  insertRowBelow(): void;
  deleteRow(): void;
  insertColumnLeft(): void;
  insertColumnRight(): void;
  deleteColumn(): void;
  hideRows(rows?: readonly number[]): void;
  showRows(rows?: readonly number[]): void;
  autoFitRows(): void;
  hideColumns(cols?: readonly number[]): void;
  showColumns(cols?: readonly number[]): void;
  autoFitColumns(cols?: readonly number[]): void;
  clearFilter(col?: number): void;
  copy(): Promise<ClipboardOutcome>;
  cut(): Promise<ClipboardOutcome>;
  paste(): Promise<ClipboardOutcome>;
  pasteValues(): Promise<ClipboardOutcome>;
  clearContents(): void;
  exportCsv(filename?: string): void;
  exportXlsx(filename?: string): void;
  undo(): void;
  redo(): void;
}