Loading documentation…
Imperative operations the toolbar and context menu bind to; also exposed as Grid.actions.
toggleBoldtoggleBold(): void;toggleItalictoggleItalic(): void;toggleUnderlinetoggleUnderline(): void;toggleStrikethroughtoggleStrikethrough(): void;setAlignsetTextColorsetTextColor(color: string): void;setFillColorsetFillColor(color: string): void;toggleBordertoggleBorder(): void;clearFormatclearFormat(): void;mergemerge(): void;unmergeunmerge(): void;sortsort(ascending: boolean): void;insertRowAboveinsertRowAbove(): void;insertRowBelowinsertRowBelow(): void;deleteRowdeleteRow(): void;insertColumnLeftinsertColumnLeft(): void;insertColumnRightinsertColumnRight(): void;deleteColumndeleteColumn(): void;hideRowshideRows(rows?: readonly number[]): void;showRowsshowRows(rows?: readonly number[]): void;autoFitRowsautoFitRows(): void;hideColumnshideColumns(cols?: readonly number[]): void;showColumnsshowColumns(cols?: readonly number[]): void;autoFitColumnsautoFitColumns(cols?: readonly number[]): void;clearFilterclearFilter(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.
clearContentsclearContents(): void;exportCsv Download the active sheet as CSV.exportCsv(filename?: string): void;Download the active sheet as CSV. Never throws; a failure emits `export-error`.
exportXlsx Download the active sheet as XLSX.exportXlsx(filename?: string): Promise<void>;Download the active sheet as XLSX. Resolves when the download starts and never rejects; a failure emits `export-error`.
undoundo(): void;redoredo(): void;export interface GridActions { toggleBold(): void; toggleItalic(): void; toggleUnderline(): void; toggleStrikethrough(): 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): Promise<void>; undo(): void; redo(): void;}Workspace packages depending on @sheetwrite/core
@sheetwrite/benchdependency@sheetwrite/docs-startdependency@sheetwrite/reactdependency@sheetwrite/sveltedependency@sheetwrite/vuedependency@sheetwrite/xlsxdependencyPublic exports naming GridActions