@sheetwrite/vuetype
Every possible projection produced by a row bridge.
- Package
@sheetwrite/vue- Source
packages/core/dist/row-bridge.d.ts#L112
Declaration
export type RowBridgeDelta<Id extends RowBridgeIdtype RowBridgeId = string | number;type RowBridgeId = string | number;type RowBridgeId =
string | number;A stable host identity for one data-space row.API reference → = RowBridgeIdtype RowBridgeId = string | number;type RowBridgeId = string | number;type RowBridgeId =
string | number;A stable host identity for one data-space row.API reference →> = | RowBridgeCellDelta<Id> | RowBridgeRangeDeltainterface RowBridgeRangeDelta<
Id extends RowBridgeId = RowBridgeId,
> {
readonly kind: "range";
readonly range: Range;
readonly cells: readonly RowBridgeCell<Id>[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}interface RowBridgeRangeDelta<
Id extends RowBridgeId = RowBridgeId,
> {
readonly kind: "range";
readonly range: Range;
readonly cells: readonly RowBridgeCell<Id>[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}interface RowBridgeRangeDelta<
Id extends RowBridgeId =
RowBridgeId,
> {
readonly kind: "range";
readonly range: Range;
readonly cells: readonly RowBridgeCell<Id>[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}A setRange/setBlock effect expanded to its exact changed cells.API reference →<Id> | RowBridgeClearDeltainterface RowBridgeClearDelta<
Id extends RowBridgeId = RowBridgeId,
> {
readonly kind: "clear";
readonly range: Range;
readonly cells: readonly RowBridgeCell<Id>[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}interface RowBridgeClearDelta<
Id extends RowBridgeId = RowBridgeId,
> {
readonly kind: "clear";
readonly range: Range;
readonly cells: readonly RowBridgeCell<Id>[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}interface RowBridgeClearDelta<
Id extends RowBridgeId =
RowBridgeId,
> {
readonly kind: "clear";
readonly range: Range;
readonly cells: readonly RowBridgeCell<Id>[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}A clearRange effect expanded to its exact changed cells.API reference →<Id> | RowBridgePasteDeltainterface RowBridgePasteDelta<
Id extends RowBridgeId = RowBridgeId,
> {
readonly kind: "paste";
readonly range: Range | null;
readonly cells: readonly RowBridgeCell<Id>[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}interface RowBridgePasteDelta<
Id extends RowBridgeId = RowBridgeId,
> {
readonly kind: "paste";
readonly range: Range | null;
readonly cells: readonly RowBridgeCell<Id>[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}interface RowBridgePasteDelta<
Id extends RowBridgeId =
RowBridgeId,
> {
readonly kind: "paste";
readonly range: Range | null;
readonly cells: readonly RowBridgeCell<Id>[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}A paste transaction effect. A paste can contain multiple canonical patches.API reference →<Id> | RowBridgeFillDeltainterface RowBridgeFillDelta<Id extends RowBridgeId = RowBridgeId> {
readonly kind: "fill";
readonly range: Range | null;
readonly cells: readonly RowBridgeCell<Id>[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}interface RowBridgeFillDelta<Id extends RowBridgeId = RowBridgeId> {
readonly kind: "fill";
readonly range: Range | null;
readonly cells: readonly RowBridgeCell<Id>[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}interface RowBridgeFillDelta<
Id extends RowBridgeId =
RowBridgeId,
> {
readonly kind: "fill";
readonly range: Range | null;
readonly cells: readonly RowBridgeCell<Id>[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}A fill-series transaction effect.API reference →<Id> | RowBridgeRowStructureDeltainterface RowBridgeRowStructureDelta<
Id extends RowBridgeId = RowBridgeId,
> {
readonly kind: "row-structure";
readonly action: "insert" | "delete" | "move";
readonly sheet: SheetId;
readonly at: number;
readonly count: number;
readonly from?: number;
readonly to?: number;
readonly inserted: readonly (Id | null)[];
readonly removed: readonly (Id | null)[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
// … 5 more lines — see the API reference
}interface RowBridgeRowStructureDelta<
Id extends RowBridgeId = RowBridgeId,
> {
readonly kind: "row-structure";
readonly action: "insert" | "delete" | "move";
readonly sheet: SheetId;
readonly at: number;
readonly count: number;
readonly from?: number;
readonly to?: number;
readonly inserted: readonly (Id | null)[];
readonly removed: readonly (Id | null)[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
// … 5 more lines — see the API reference
}interface RowBridgeRowStructureDelta<
Id extends RowBridgeId =
RowBridgeId,
> {
readonly kind: "row-structure";
readonly action:
"insert" | "delete" | "move";
readonly sheet: SheetId;
readonly at: number;
readonly count: number;
readonly from?: number;
readonly to?: number;
readonly inserted: readonly (Id | null)[];
readonly removed: readonly (Id | null)[];
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
// … 3 more lines — see the API reference
}Stable row identity effects for insert, delete, and move operations.API reference →<Id> | RowBridgeMetadataDeltainterface RowBridgeMetadataDelta<
Id extends RowBridgeId = RowBridgeId,
> {
readonly kind: "metadata";
readonly metadata:
| "column"
| "row"
| "sheet"
| "merge"
| "table"
| "validation"
| "hyperlink"
| "protected-range"
| "note"
| "named-range";
// … 8 more lines — see the API reference
}interface RowBridgeMetadataDelta<
Id extends RowBridgeId = RowBridgeId,
> {
readonly kind: "metadata";
readonly metadata:
| "column"
| "row"
| "sheet"
| "merge"
| "table"
| "validation"
| "hyperlink"
| "protected-range"
| "note"
| "named-range";
// … 8 more lines — see the API reference
}interface RowBridgeMetadataDelta<
Id extends RowBridgeId =
RowBridgeId,
> {
readonly kind: "metadata";
readonly metadata:
| "column"
| "row"
| "sheet"
| "merge"
| "table"
| "validation"
| "hyperlink"
| "protected-range"
| "note"
| "named-range";
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
// … 5 more lines — see the API reference
}A document operation that changes workbook or column metadata.API reference →<Id> | RowBridgeHostActionDeltainterface RowBridgeHostActionDelta<
Id extends RowBridgeId = RowBridgeId,
> {
readonly kind: "host-action";
readonly action:
| "add-sheet"
| "remove-sheet"
| "rename-sheet"
| "move-sheet"
| "set-sheet-visibility";
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
// … 3 more lines — see the API reference
}interface RowBridgeHostActionDelta<
Id extends RowBridgeId = RowBridgeId,
> {
readonly kind: "host-action";
readonly action:
| "add-sheet"
| "remove-sheet"
| "rename-sheet"
| "move-sheet"
| "set-sheet-visibility";
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
// … 3 more lines — see the API reference
}interface RowBridgeHostActionDelta<
Id extends RowBridgeId =
RowBridgeId,
> {
readonly kind: "host-action";
readonly action:
| "add-sheet"
| "remove-sheet"
| "rename-sheet"
| "move-sheet"
| "set-sheet-visibility";
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}A document operation that needs a host-side action rather than row mutation.API reference →<Id> | RowBridgeUnprojectableDeltainterface RowBridgeUnprojectableDelta<
Id extends RowBridgeId = RowBridgeId,
> {
readonly kind: "unprojectable";
readonly reason: string;
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}interface RowBridgeUnprojectableDelta<
Id extends RowBridgeId = RowBridgeId,
> {
readonly kind: "unprojectable";
readonly reason: string;
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}interface RowBridgeUnprojectableDelta<
Id extends RowBridgeId =
RowBridgeId,
> {
readonly kind: "unprojectable";
readonly reason: string;
readonly transaction: RowBridgeTransaction;
readonly transactionId: string;
readonly source: OperationSource;
readonly previous: unknown;
readonly next: unknown;
readonly operation: DocumentOp;
readonly rowIds: readonly (Id | null)[];
}An explicit projection record for an operation with no row-space meaning.API reference →<Id>;