[]
        
(Showing Draft Content)

README

spreadjs-api

Table of contents

列挙体

インターフェイス

型の別名

変数

関数

型の別名

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; }

変数

type

• type: OT_Type<unknown, IChangeSet>

スプレッドシートのOTタイプを定義します。

関数

bind

▸ bind(workbook, doc): Promise<void>

ワークブックを共有ドキュメントにバインドします。

パラメータ

名前 型 説明
workbook any GC.Spread.Sheets.Workbookのインスタンス。
doc SharedDoc<any, IChangeSet> SharedDocのインスタンス。

戻り値

Promise<void>

バインディングが完了したときに解決するプロミス。


bindPresence

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

ワークブックをプレゼンスのインスタンスにバインドします。

パラメータ

名前 型 説明
workbook any GC.Spread.Sheets.Workbookのインスタンス。
presence Presence<IPresence> プレゼンスのインスタンス。
user IUserWithPermission ユーザー情報。
options? IBindPresenceOptions -

戻り値

Promise<void>

バインディングが完了したときに解決するプロミス。