@sheetwrite/coreinterface
A clearRange effect expanded to its exact changed cells.
- Package
@sheetwrite/core- Source
packages/core/src/row-bridge.ts#L82
Members 10
kind
readonly kind: "clear";range
readonly range: Rangeinterface Range {
sheet: SheetId;
start: { row: number; col: number };
end: { row: number; col: number };
}interface Range {
sheet: SheetId;
start: { row: number; col: number };
end: { row: number; col: number };
}interface Range {
sheet: SheetId;
start: {
row: number;
col: number;
};
end: {
row: number;
col: number;
};
}Inclusive rectangular cell range on a stable sheet ID.API reference →;cells
readonly cells: readonly RowBridgeCellinterface RowBridgeCell<Id extends RowBridgeId = RowBridgeId> {
readonly sheet: SheetId;
readonly row: number;
readonly rowId: Id | null;
readonly col: number;
readonly columnKey: string | null;
readonly previous: CellValue | undefined;
readonly next: CellValue | undefined;
}interface RowBridgeCell<Id extends RowBridgeId = RowBridgeId> {
readonly sheet: SheetId;
readonly row: number;
readonly rowId: Id | null;
readonly col: number;
readonly columnKey: string | null;
readonly previous: CellValue | undefined;
readonly next: CellValue | undefined;
}interface RowBridgeCell<
Id extends RowBridgeId =
RowBridgeId,
> {
readonly sheet: SheetId;
readonly row: number;
readonly rowId: Id | null;
readonly col: number;
readonly columnKey:
string | null;
readonly previous:
CellValue | undefined;
readonly next:
CellValue | undefined;
}A cell effect with semantic column and host row identity.API reference →<Id>[];transaction
readonly transaction: RowBridgeTransactioninterface RowBridgeTransaction {
readonly id: string;
readonly source: OperationSource;
readonly commitReason: CommitReason;
readonly epoch: number | undefined;
readonly patches: readonly DocumentOp[];
}interface RowBridgeTransaction {
readonly id: string;
readonly source: OperationSource;
readonly commitReason: CommitReason;
readonly epoch: number | undefined;
readonly patches: readonly DocumentOp[];
}interface RowBridgeTransaction {
readonly id: string;
readonly source: OperationSource;
readonly commitReason: CommitReason;
readonly epoch:
number | undefined;
readonly patches: readonly DocumentOp[];
}The canonical transaction identity carried by each projected delta.API reference →;transactionId
readonly transactionId: string;source
readonly source: OperationSourcetype OperationSource = "local" | "remote";type OperationSource = "local" | "remote";type OperationSource =
"local" | "remote";Whether a committed change originated locally or from remote host input.API reference →;previous
readonly previous: unknown;next
readonly next: unknown;operation
readonly operation: DocumentOptype DocumentOp =
| {
op: "set";
addr: CellAddress;
value: CellValue;
style?: CellStyle;
}
| { op: "setRange"; range: Range; cells: SnapshotCell[] }
| { op: "setBlock"; range: Range; block: PackedCellBlock }
| {
op: "setRangeStyle";
range: Range;
style: Partial<CellStyle> | null;
}
| {
// … 93 more lines — see the API reference
}type DocumentOp =
| {
op: "set";
addr: CellAddress;
value: CellValue;
style?: CellStyle;
}
| { op: "setRange"; range: Range; cells: SnapshotCell[] }
| { op: "setBlock"; range: Range; block: PackedCellBlock }
| {
op: "setRangeStyle";
range: Range;
style: Partial<CellStyle> | null;
}
| {
// … 93 more lines — see the API reference
}type DocumentOp =
| {
op: "set";
addr: CellAddress;
value: CellValue;
style?: CellStyle;
}
| {
op: "setRange";
range: Range;
cells: SnapshotCell[];
}
| {
op: "setBlock";
range: Range;
block: PackedCellBlock;
}
| {
op: "setRangeStyle";
// … 168 more lines — see the API reference
}Exhaustive serializable operation union for workbook mutations.API reference →;rowIds
readonly rowIds: readonly (Id | null)[];Declaration
View full TypeScript declaration
export interface RowBridgeClearDelta<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 →> { readonly kind: "clear"; readonly range: Rangeinterface Range {
sheet: SheetId;
start: { row: number; col: number };
end: { row: number; col: number };
}interface Range {
sheet: SheetId;
start: { row: number; col: number };
end: { row: number; col: number };
}interface Range {
sheet: SheetId;
start: {
row: number;
col: number;
};
end: {
row: number;
col: number;
};
}Inclusive rectangular cell range on a stable sheet ID.API reference →; readonly cells: readonly RowBridgeCellinterface RowBridgeCell<Id extends RowBridgeId = RowBridgeId> {
readonly sheet: SheetId;
readonly row: number;
readonly rowId: Id | null;
readonly col: number;
readonly columnKey: string | null;
readonly previous: CellValue | undefined;
readonly next: CellValue | undefined;
}interface RowBridgeCell<Id extends RowBridgeId = RowBridgeId> {
readonly sheet: SheetId;
readonly row: number;
readonly rowId: Id | null;
readonly col: number;
readonly columnKey: string | null;
readonly previous: CellValue | undefined;
readonly next: CellValue | undefined;
}interface RowBridgeCell<
Id extends RowBridgeId =
RowBridgeId,
> {
readonly sheet: SheetId;
readonly row: number;
readonly rowId: Id | null;
readonly col: number;
readonly columnKey:
string | null;
readonly previous:
CellValue | undefined;
readonly next:
CellValue | undefined;
}A cell effect with semantic column and host row identity.API reference →<Id>[]; readonly transaction: RowBridgeTransactioninterface RowBridgeTransaction {
readonly id: string;
readonly source: OperationSource;
readonly commitReason: CommitReason;
readonly epoch: number | undefined;
readonly patches: readonly DocumentOp[];
}interface RowBridgeTransaction {
readonly id: string;
readonly source: OperationSource;
readonly commitReason: CommitReason;
readonly epoch: number | undefined;
readonly patches: readonly DocumentOp[];
}interface RowBridgeTransaction {
readonly id: string;
readonly source: OperationSource;
readonly commitReason: CommitReason;
readonly epoch:
number | undefined;
readonly patches: readonly DocumentOp[];
}The canonical transaction identity carried by each projected delta.API reference →; readonly transactionId: string; readonly source: OperationSourcetype OperationSource = "local" | "remote";type OperationSource = "local" | "remote";type OperationSource =
"local" | "remote";Whether a committed change originated locally or from remote host input.API reference →; readonly previous: unknown; readonly next: unknown; readonly operation: DocumentOptype DocumentOp =
| {
op: "set";
addr: CellAddress;
value: CellValue;
style?: CellStyle;
}
| { op: "setRange"; range: Range; cells: SnapshotCell[] }
| { op: "setBlock"; range: Range; block: PackedCellBlock }
| {
op: "setRangeStyle";
range: Range;
style: Partial<CellStyle> | null;
}
| {
// … 93 more lines — see the API reference
}type DocumentOp =
| {
op: "set";
addr: CellAddress;
value: CellValue;
style?: CellStyle;
}
| { op: "setRange"; range: Range; cells: SnapshotCell[] }
| { op: "setBlock"; range: Range; block: PackedCellBlock }
| {
op: "setRangeStyle";
range: Range;
style: Partial<CellStyle> | null;
}
| {
// … 93 more lines — see the API reference
}type DocumentOp =
| {
op: "set";
addr: CellAddress;
value: CellValue;
style?: CellStyle;
}
| {
op: "setRange";
range: Range;
cells: SnapshotCell[];
}
| {
op: "setBlock";
range: Range;
block: PackedCellBlock;
}
| {
op: "setRangeStyle";
// … 168 more lines — see the API reference
}Exhaustive serializable operation union for workbook mutations.API reference →; readonly rowIds: readonly (Id | null)[];}