Skip to main content
Shared editing: a replica of the workbook that merges the edits of other users.

XlsxReplica

Shared editing for workbooks: a workbook’s edits as changes for a central sequencer, and other writers’ changes written back in. Pure and browser-safe, with no DOM types, so a server writer loads it; XlsxEditorCollab is in @reductoai/xlsx/editor. Import from @reductoai/xlsx/collab.

XlsxReplica properties

XlsxReplica.ack()

XlsxReplica.cells()

Every cell of a sheet as it travels, for a convergence check.

XlsxReplica.close()

XlsxReplica.commit()

Reads local edits since the last call and hands them to the client; returns what was read.

XlsxReplica.decoded()

The mirror’s view of a part, for a convergence check.

XlsxReplica.parts()

Every part the mirror holds, for a convergence check.

XlsxReplica.remote()

Another writer’s change sequenced as seq; returns the parts it rewrote and the rows and columns it moved.

XlsxReplica.resend()

XlsxReplicaOptions

Shared editing for workbooks: a workbook’s edits as changes for a central sequencer, and other writers’ changes written back in. Pure and browser-safe, with no DOM types, so a server writer loads it; XlsxEditorCollab is in @reductoai/xlsx/editor. Import from @reductoai/xlsx/collab.

XlsxEditorCollab

Import from @reductoai/xlsx/editor.

XlsxEditorCollab properties

XlsxEditorCollab.ack()

XlsxEditorCollab.apply()

XlsxEditorCollab.close()

XlsxEditorCollab.leave()

Tells the others this writer left.

XlsxEditorCollab.location()

This writer’s place as it travels.

XlsxEditorCollab.peers()

Every other writer whose sheet still exists.

XlsxEditorCollab.publish()

XlsxEditorCollab.receivePresence()

Takes another writer’s place; true when the marks changed.

XlsxEditorCollab.remote()

Another writer’s change; the editor’s selection follows its cells.

XlsxEditorCollab.resend()

XlsxEditorCollab.settle()

Sends what the editor did outside apply (the grid’s typing, a script) and its place.