- GC
- GC.Data
- GC.Pivot
- GC.Spread.Pivot
- GC.Spread.Slicers
- GC.Spread.CalcEngine
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Report
- GC.Spread.Sheets
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.IO
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.Search
- GC.Spread.Sheets.CellState
- GC.Spread.Sheets.CellTypes
- GC.Spread.Sheets.Charts
- GC.Spread.Sheets.DataCharts
- GC.Spread.Sheets.Commands
- GC.Spread.Sheets.Comments
- GC.Spread.Sheets.ThreadedComments
- GC.Spread.Sheets.ConditionalFormatting
- GC.Spread.Sheets.ContextMenu
- GC.Spread.Sheets.Collaboration
- GC.Spread.Sheets.DataValidation
- GC.Spread.Sheets.DataRange
- GC.Spread.Sheets.Fill
- GC.Spread.Sheets.Filter
- GC.Spread.Sheets.FloatingObjects
- GC.Spread.Sheets.FormulaTextBox
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.FormulaPanel
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.InputMask
- GC.Spread.Sheets.Print
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.Shapes
- GC.Spread.Sheets.Slicers
- GC.Spread.Sheets.Sparklines
- GC.Spread.Sheets.StatusBar
- GC.Spread.Sheets.Tables
- GC.Spread.Sheets.TableSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Sheets.Designer
- GC.Spread.Sheets.GanttSheet
- GC.Spread.Sheets.AI
-
Collaboration
- js-collaboration
- js-collaboration-client
-
js-collaboration-ot
- classes
- enums
-
interfaces
- ICommitSnapshot
- IContext
- ICustomOptions
- ICreateComponent
- IDatabaseAdapter
- IMilestoneDatabaseAdapter
- IDocConfig
- IDocHookContext
- IDocMiddlewareContext
- IDocMiddlewareContextBase
- IDocReadOpMiddlewareContext
- IDocReadSnapshotsMiddlewareContext
- IDocReceiveMiddlewareContext
- IDocReplyMiddlewareContext
- IDocSubmitMiddlewareContext
- IDocument
- IErrorData
- IOp
- IReplyMessage
- IRequestMessage
- IRequestMessageExtra
- ISnapshot
- ISnapshotFragmentsRequest
- ISnapshotFragmentsChanges
- ISnapshotMeta
- OT_Type
- IReadOpRequest
- IRestoreComponent
- Overview
- js-collaboration-ot-client
- js-collaboration-ot-postgres
- js-collaboration-ot-sqlite
- js-collaboration-presence
- js-collaboration-presence-client
- spread-sheets-collaboration
- spread-sheets-collaboration-client
- GC.Spread.Excel
OT_Type
Interface: OT_Type<S, T>
Defines the interface for customizing operational transformation (OT) behavior in collaboration.
Type parameters
| Name | Type | Description |
|---|---|---|
S |
unknown |
The type of snapshot data. |
T |
unknown |
The type of op data. |
Table of contents
Properties
Methods
Properties
uri
• uri: string
The URI identifying the document type.
Methods
apply
▸ Optional apply(snapshot, op): S
Applies an operation to snapshot data.
Parameters
| Name | Type | Description |
|---|---|---|
snapshot |
S |
The current snapshot data. |
op |
T |
The operation to apply. |
Returns
S
The updated snapshot data.
applyFragments
▸ Optional applyFragments(request, op): Promise<void>
Applies an operation to snapshot fragments asynchronously.
Parameters
| Name | Type | Description |
|---|---|---|
request |
ISnapshotFragmentsRequest<unknown> |
The request containing snapshot fragments. |
op |
T |
The operation to apply. |
Returns
Promise<void>
A promise that resolves when the operation is applied.
composeFragments
▸ Optional composeFragments(fragments): S
Composes snapshot data from snapshot fragments.
Parameters
| Name | Type | Description |
|---|---|---|
fragments |
ISnapshotFragments<unknown> |
The snapshot fragments. |
Returns
S
The composed snapshot data.
create
▸ Optional create(data): S
Creates initial snapshot data from provided data.
Parameters
| Name | Type | Description |
|---|---|---|
data |
S |
The initial snapshot data. |
Returns
S
The created snapshot data.
createFragments
▸ Optional createFragments(data): ISnapshotFragments<unknown>
Generates snapshot fragments from snapshot data.
Parameters
| Name | Type | Description |
|---|---|---|
data |
S |
The snapshot data. |
Returns
ISnapshotFragments<unknown>
The generated snapshot fragments.
transform
▸ transform(op1, op2, side): T
Transforms an operation to resolve conflicts with another operation.
Parameters
| Name | Type | Description |
|---|---|---|
op1 |
T |
The operation to transform. |
op2 |
T |
The operation serving as the basis for transformation. |
side |
"left" | "right" |
Indicates which operation arrived at the server later. |
Returns
T
The transformed operation.