RowBridgeMetadataDelta | @sheetwrite/core

A document operation that changes workbook or column metadata.

Package: @sheetwrite/core
Source: packages/core/src/row-bridge.ts#L120

Members 9

kind

readonly kind: "metadata";

metadata

readonly metadata: | "column" | "row" | "sheet" | "merge" | "table" | "validation" | "hyperlink" | "protected-range" | "note" | "named-range";

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 RowBridgeMetadataDelta<
  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: "metadata";
  readonly metadata:
    | "column"
    | "row"
    | "sheet"
    | "merge"
    | "table"
    | "validation"
    | "hyperlink"
    | "protected-range"
    | "note"
    | "named-range";
  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)[];
}