FWorkbookSheetsZenEditorMixin

GitHubEdit on GitHub
packages@univerjs/sheets-zen-editor

APIs

endZenEditingAsync

End the zen editing process on the active cell and optionally save the changes

Signature

endZenEditingAsync(save?: boolean = true): Promise<boolean>

Parameters

  • save (boolean) — - Whether to save the changes, default is true

Returns

  • (Promise<boolean>) — A promise that resolves to a boolean indicating whether the zen editing process was ended successfully.

Tags

  • @async

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const success = await fWorkbook.endZenEditingAsync(false)
console.log(success)

startZenEditingAsync

Enter the zen editing process on the active cell

Signature

startZenEditingAsync(): Promise<boolean>

Returns

  • (Promise<boolean>) — A promise that resolves to a boolean indicating whether the zen editing process was started successfully.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const success = await fWorkbook.startZenEditingAsync()
console.log(success)