@sheetwrite/vueinterface
Event payloads emitted by the Vue components, keyed by template event name.
- Package
@sheetwrite/vue- Source
packages/vue/src/index.ts#L102
Members 9
grid-change Committed Grid change, including its applied transaction.
"grid-change": ChangeEventinterface ChangeEvent {
transaction: Transaction;
changes: CellChange[];
commitReason: CommitReason;
source: OperationSource;
epoch?: number;
}interface ChangeEvent {
transaction: Transaction;
changes: CellChange[];
commitReason: CommitReason;
source: OperationSource;
epoch?: number;
}interface ChangeEvent {
transaction: Transaction;
changes: CellChange[];
commitReason: CommitReason;
source: OperationSource;
epoch?: number;
}Payload of the change event; flows OUT for API submission/reconcile.API reference →;selection-change Current selection, or null after it is cleared.
"selection-change": Selectiontype Selection =
| { kind: "cell"; addr: CellAddress }
| { kind: "range"; range: Range }
| { kind: "row"; sheet: SheetId; row: number }
| { kind: "column"; sheet: SheetId; col: number }
| { kind: "multi"; ranges: Range[] };type Selection =
| { kind: "cell"; addr: CellAddress }
| { kind: "range"; range: Range }
| { kind: "row"; sheet: SheetId; row: number }
| { kind: "column"; sheet: SheetId; col: number }
| { kind: "multi"; ranges: Range[] };type Selection =
| {
kind: "cell";
addr: CellAddress;
}
| {
kind: "range";
range: Range;
}
| {
kind: "row";
sheet: SheetId;
row: number;
}
| {
kind: "column";
sheet: SheetId;
col: number;
}
// … 4 more lines — see the API reference
}Current cell, range, row, column, or multi-range selection.API reference → | null;viewport-change Visible row bounds and vertical scroll offset after scrolling.
"viewport-change": GridEventsinterface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: {
selection: Selection | null;
};
scroll: {
scrollTop: number;
firstRow: number;
lastRow: number;
};
"edit-begin": {
addr: CellAddress;
};
"edit-commit": {
addr: CellAddress;
value: CellValue;
};
search: SearchResult;
"mutation-rejected": {
// … 21 more lines — see the API reference
}Payload map for events emitted by a Grid.API reference →["scroll"];edit-begin Cell editing began.
"edit-begin": GridEventsinterface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: {
selection: Selection | null;
};
scroll: {
scrollTop: number;
firstRow: number;
lastRow: number;
};
"edit-begin": {
addr: CellAddress;
};
"edit-commit": {
addr: CellAddress;
value: CellValue;
};
search: SearchResult;
"mutation-rejected": {
// … 21 more lines — see the API reference
}Payload map for events emitted by a Grid.API reference →["edit-begin"];edit-commit An edit committed its parsed cell value.
"edit-commit": GridEventsinterface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: {
selection: Selection | null;
};
scroll: {
scrollTop: number;
firstRow: number;
lastRow: number;
};
"edit-begin": {
addr: CellAddress;
};
"edit-commit": {
addr: CellAddress;
value: CellValue;
};
search: SearchResult;
"mutation-rejected": {
// … 21 more lines — see the API reference
}Payload map for events emitted by a Grid.API reference →["edit-commit"];search Refreshed search matches and active-match index.
search: GridEventsinterface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: {
selection: Selection | null;
};
scroll: {
scrollTop: number;
firstRow: number;
lastRow: number;
};
"edit-begin": {
addr: CellAddress;
};
"edit-commit": {
addr: CellAddress;
value: CellValue;
};
search: SearchResult;
"mutation-rejected": {
// … 21 more lines — see the API reference
}Payload map for events emitted by a Grid.API reference →["search"];active-sheet-change The visible sheet changed.
"active-sheet-change": GridEventsinterface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: {
selection: Selection | null;
};
scroll: {
scrollTop: number;
firstRow: number;
lastRow: number;
};
"edit-begin": {
addr: CellAddress;
};
"edit-commit": {
addr: CellAddress;
value: CellValue;
};
search: SearchResult;
"mutation-rejected": {
// … 21 more lines — see the API reference
}Payload map for events emitted by a Grid.API reference →["active-sheet"];ready The adapter published a ready Grid generation.
ready: GridReadyEventinterface GridReadyEvent {
grid: Grid;
generation: number;
reason: GridReadyReason;
}interface GridReadyEvent {
grid: Grid;
generation: number;
reason: GridReadyReason;
}interface GridReadyEvent {
grid: Grid;
generation: number;
reason: GridReadyReason;
}Grid handle, generation, and reason published after adapter initialization.API reference →;initialization-error WASM initialization failed while the component stayed mounted.
"initialization-error": unknown;Declaration
View full TypeScript declaration
export interface SheetwriteGridEmits { "grid-change": ChangeEventinterface ChangeEvent {
transaction: Transaction;
changes: CellChange[];
commitReason: CommitReason;
source: OperationSource;
epoch?: number;
}interface ChangeEvent {
transaction: Transaction;
changes: CellChange[];
commitReason: CommitReason;
source: OperationSource;
epoch?: number;
}interface ChangeEvent {
transaction: Transaction;
changes: CellChange[];
commitReason: CommitReason;
source: OperationSource;
epoch?: number;
}Payload of the change event; flows OUT for API submission/reconcile.API reference →; "selection-change": Selectiontype Selection =
| { kind: "cell"; addr: CellAddress }
| { kind: "range"; range: Range }
| { kind: "row"; sheet: SheetId; row: number }
| { kind: "column"; sheet: SheetId; col: number }
| { kind: "multi"; ranges: Range[] };type Selection =
| { kind: "cell"; addr: CellAddress }
| { kind: "range"; range: Range }
| { kind: "row"; sheet: SheetId; row: number }
| { kind: "column"; sheet: SheetId; col: number }
| { kind: "multi"; ranges: Range[] };type Selection =
| {
kind: "cell";
addr: CellAddress;
}
| {
kind: "range";
range: Range;
}
| {
kind: "row";
sheet: SheetId;
row: number;
}
| {
kind: "column";
sheet: SheetId;
col: number;
}
// … 4 more lines — see the API reference
}Current cell, range, row, column, or multi-range selection.API reference → | null; "viewport-change": GridEventsinterface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: {
selection: Selection | null;
};
scroll: {
scrollTop: number;
firstRow: number;
lastRow: number;
};
"edit-begin": {
addr: CellAddress;
};
"edit-commit": {
addr: CellAddress;
value: CellValue;
};
search: SearchResult;
"mutation-rejected": {
// … 21 more lines — see the API reference
}Payload map for events emitted by a Grid.API reference →["scroll"]; "edit-begin": GridEventsinterface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: {
selection: Selection | null;
};
scroll: {
scrollTop: number;
firstRow: number;
lastRow: number;
};
"edit-begin": {
addr: CellAddress;
};
"edit-commit": {
addr: CellAddress;
value: CellValue;
};
search: SearchResult;
"mutation-rejected": {
// … 21 more lines — see the API reference
}Payload map for events emitted by a Grid.API reference →["edit-begin"]; "edit-commit": GridEventsinterface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: {
selection: Selection | null;
};
scroll: {
scrollTop: number;
firstRow: number;
lastRow: number;
};
"edit-begin": {
addr: CellAddress;
};
"edit-commit": {
addr: CellAddress;
value: CellValue;
};
search: SearchResult;
"mutation-rejected": {
// … 21 more lines — see the API reference
}Payload map for events emitted by a Grid.API reference →["edit-commit"]; search: GridEventsinterface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: {
selection: Selection | null;
};
scroll: {
scrollTop: number;
firstRow: number;
lastRow: number;
};
"edit-begin": {
addr: CellAddress;
};
"edit-commit": {
addr: CellAddress;
value: CellValue;
};
search: SearchResult;
"mutation-rejected": {
// … 21 more lines — see the API reference
}Payload map for events emitted by a Grid.API reference →["search"]; "active-sheet-change": GridEventsinterface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: { selection: Selection | null };
scroll: { scrollTop: number; firstRow: number; lastRow: number };
"edit-begin": { addr: CellAddress };
"edit-commit": { addr: CellAddress; value: CellValue };
search: SearchResult;
"mutation-rejected": { issues: MutationIssue[] };
"active-sheet": { sheet: SheetId };
"renderer-fallback": { requested: "worker"; error: unknown };
"datasource-error": {
request: Omit<DataSourceRequest, "signal">;
error: unknown;
};
"export-error": { format: "xlsx"; error: unknown };
}interface GridEvents {
change: ChangeEvent;
selection: {
selection: Selection | null;
};
scroll: {
scrollTop: number;
firstRow: number;
lastRow: number;
};
"edit-begin": {
addr: CellAddress;
};
"edit-commit": {
addr: CellAddress;
value: CellValue;
};
search: SearchResult;
"mutation-rejected": {
// … 21 more lines — see the API reference
}Payload map for events emitted by a Grid.API reference →["active-sheet"]; ready: GridReadyEventinterface GridReadyEvent {
grid: Grid;
generation: number;
reason: GridReadyReason;
}interface GridReadyEvent {
grid: Grid;
generation: number;
reason: GridReadyReason;
}interface GridReadyEvent {
grid: Grid;
generation: number;
reason: GridReadyReason;
}Grid handle, generation, and reason published after adapter initialization.API reference →; "initialization-error": unknown;}