FUniverDocsMixin

APIs

createUniverDoc

Create a new document and get the API handler of that document.

Signature

createUniverDoc(data: Partial<IDocumentData>): FDocument

Parameters

• data (Partial<IDocumentData>) — The snapshot of the document.

Returns

• (FDocument) — FDocument API instance.

getActiveDocument

Get the currently focused Univer document.

Signature

getActiveDocument(): FDocument | null

Returns

• (FDocument | null) — The currently focused Univer document.

getUniverDoc

Get the document API handler by the document id.

Signature

getUniverDoc(id: string): FDocument | null

Parameters

• id (string) — The document id.

Returns

• (FDocument | null) — The document API instance.