spreadjs-api

Table of contents

Enumerations

• BrowsingMode
• OpType
• PermissionTypes

Interfaces

• IBindPresenceOptions
• IChangeSet
• IOpComponent
• IPermission
• IPresence
• IRange
• ISelections
• IUser
• IUserWithPermission

Type aliases

• IImageSource

Variables

• type

Functions

• bind
• bindPresence

Type aliases

IImageSource

Ƭ IImageSource: { kind: "url" ; src: string } | { dataUrl: string ; kind: "data" } | { blobUrl: string ; kind: "blobUrl" } | { blob: Blob ; kind: "blob" } | { file: File ; kind: "file" }

{ kind: 'url'; src: string; } | { kind: 'data'; dataUrl: string; } | { kind: 'blobUrl'; blobUrl: string; } | { kind: 'blob'; blob: Blob; } | { kind: 'file'; file: File; }

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

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

Returns

Promise<void>

A promise that resolves when the binding is complete.