@univerjs/sheets-ui v0.5.1 • Docs
Interface: IFWorkbookSheetsUIMixin
Methods
endEditing()
endEditing(save?): Promise<boolean>End the editing process
Parameters
| Parameter | Type | Description |
|---|---|---|
save? | boolean | Whether to save the changes |
Returns
Promise<boolean>
A promise that resolves to a boolean value
Async
Defined in
submodules/univer/packages/sheets-ui/src/facade/f-workbook.ts:75
onCellClick()
onCellClick(callback): IDisposableSubscribe to cell click events
Parameters
| Parameter | Type | Description |
|---|---|---|
callback | (cell) => void | The callback function to be called when a cell is clicked |
Returns
A disposable object that can be used to unsubscribe from the event
Defined in
submodules/univer/packages/sheets-ui/src/facade/f-workbook.ts:53
onCellHover()
onCellHover(callback): IDisposableSubscribe cell hover events
Parameters
| Parameter | Type | Description |
|---|---|---|
callback | (cell) => void | The callback function to be called when a cell is hovered |
Returns
A disposable object that can be used to unsubscribe from the event
Defined in
submodules/univer/packages/sheets-ui/src/facade/f-workbook.ts:61
openDialog()
openDialog(dialog): IDisposableOpen a dialog.
Parameters
| Parameter | Type | Description |
|---|---|---|
dialog | IDialogPartMethodOptions | the dialog options |
Returns
the disposable object
Deprecated
Defined in
submodules/univer/packages/sheets-ui/src/facade/f-workbook.ts:45
openSiderbar()
openSiderbar(params): IDisposableOpen a sidebar.
Parameters
| Parameter | Type | Description |
|---|---|---|
params | ISidebarMethodOptions | the sidebar options |
Returns
the disposable object
Deprecated
Defined in
submodules/univer/packages/sheets-ui/src/facade/f-workbook.ts:35
startEditing()
startEditing(): booleanStart the editing process
Returns
boolean
A boolean value
Defined in
submodules/univer/packages/sheets-ui/src/facade/f-workbook.ts:67