[]
        
(Showing Draft Content)

README

spreadjs-api

Table of contents

Enumerations

Interfaces

Variables

Functions

Variables

type

type: OT_Type<unknown, IChangeSet>

Defines the OT type for spreadsheets.

Functions

bind

bind(workbook, doc): Promise<void>

Binds a workbook to a shared document.

Parameters

Name Type Description
workbook any The instance of GC.Spread.Sheets.Workbook.
doc SharedDoc<any, IChangeSet> The instance of SharedDoc.

Returns

Promise<void>

A promise that resolves when the binding is complete.


bindPresence

bindPresence(workbook, presence, user, options?): Promise<void>

Binds a workbook to a presence instance.

Parameters

Name Type Description
workbook any The instance of GC.Spread.Sheets.Workbook.
presence Presence<IPresence> The presence instance.
user IUser The user information.
options? IBindPresenceOptions -

Returns

Promise<void>

A promise that resolves when the binding is complete.