FWorkbookSheetsUIMixin

packages	`@univerjs/sheets-ui`

APIs

`abortEditingAsync`

Signature

abortEditingAsync(): Promise<boolean>

Returns

(Promise<boolean>) — Whether the editing process is ended successfully

Tags

@async — End the editing process of the current active cell

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
await fWorkbook.abortEditingAsync()

`customizeColumnHeader`

Customize the column header of the all worksheets in the workbook.

Signature

customizeColumnHeader(cfg: IColumnsHeaderCfgParam): void

Parameters

cfg (IColumnsHeaderCfgParam) — The configuration of the column header.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.customizeColumnHeader({
  headerStyle: {
    fontColor: '#fff',
    backgroundColor: '#4e69ee',
    fontSize: 9,
  },
  columnsCfg: {
    0: 'kuma II',
    3: {
      text: 'Size',
      textAlign: 'left', // CanvasTextAlign
      fontColor: '#fff',
      fontSize: 12,
      borderColor: 'pink',
      backgroundColor: 'pink',
    },
    4: 'Wow',
  },
})

`customizeRowHeader`

Customize the row header of the all worksheets in the workbook.

Signature

customizeRowHeader(cfg: IRowsHeaderCfgParam): void

Parameters

cfg (IRowsHeaderCfgParam) — The configuration of the row header.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.customizeRowHeader({
  headerStyle: {
    backgroundColor: 'pink',
    fontSize: 12,
  },
  rowsCfg: {
    0: 'Moka II',
    3: {
      text: 'Size',
      textAlign: 'left', // CanvasTextAlign
    },
  },
})

`disableSelection`

Disable selection. After disabled, there would be no response for selection.

Signature

disableSelection(): FWorkbook

Returns

(FWorkbook) — FWorkbook instance for chaining

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.disableSelection()

`enableSelection`

Enable selection. After this you can select range.

Signature

enableSelection(): FWorkbook

Returns

(FWorkbook) — FWorkbook instance for chaining

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.enableSelection()

`endEditing`

Deprecated Use endEditingAsync as instead

Signature

endEditing(save?: boolean): Promise<boolean>

`endEditingAsync`

Signature

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

Parameters

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

Returns

(Promise<boolean>) — Whether the editing process is ended successfully

Tags

@async — End the editing process of the current active cell

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
await fWorkbook.endEditingAsync(false)

`generateCellParams`

Signature

generateCellParams(cell: IHoverRichTextPosition | ICellPosWithEvent): ICellEventParam

`getScrollStateBySheetId`

Get scroll state of specified sheet.

Signature

getScrollStateBySheetId(sheetId: string): Nullable<IScrollState>

Parameters

sheetId (string) — - sheet id

Returns

(Nullable<IScrollState>) — scroll state

Examples

univerAPI.getActiveWorkbook().getScrollStateBySheetId($sheetId)

`isCellEditing`

Check if the current active cell is in editing state

Signature

isCellEditing(): boolean

Returns

(boolean) — True if the current active cell is in editing state, false otherwise

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const isEditing = fWorkbook.isCellEditing()
console.log(isEditing)

`onCellClick`

Deprecated use univerAPI.addEvent(univerAPI.Event.CellClicked, (params) => \{\}) instead

Signature

onCellClick(callback: (cell: IHoverRichTextInfo) => void): IDisposable

`onCellHover`

Deprecated use univerAPI.addEvent(univerAPI.Event.CellHover, (params) => \{\}) instead

Signature

onCellHover(callback: (cell: IHoverRichTextPosition) => void): IDisposable

`onCellPointerDown`

Deprecated use univerAPI.addEvent(univerAPI.Event.CellPointerDown, (params) => \{\}) instead

Signature

onCellPointerDown(callback: (cell: ICellPosWithEvent) => void): IDisposable

`onCellPointerMove`

Deprecated use univerAPI.addEvent(univerAPI.Event.CellPointerMove, (params) => \{\}) instead

Signature

onCellPointerMove(callback: (cell: ICellPosWithEvent, event: IPointerEvent | IMouseEvent) => void): IDisposable

`onCellPointerUp`

Deprecated use univerAPI.addEvent(univerAPI.Event.CellPointerUp, (params) => \{\}) instead

Signature

onCellPointerUp(callback: (cell: ICellPosWithEvent) => void): IDisposable

`onDragOver`

Deprecated use univerAPI.addEvent(univerAPI.Event.DragOver, (params) => \{\}) instead

Signature

onDragOver(callback: (cell: IDragCellPosition) => void): IDisposable

`onDrop`

Deprecated use univerAPI.addEvent(univerAPI.Event.Drop, (params) => \{\}) instead

Signature

onDrop(callback: (cell: IDragCellPosition) => void): IDisposable

`openDialog`

Open a dialog.

Deprecated use univerAPI.openDialog instead

Signature

openDialog(dialog: IDialogPartMethodOptions): IDisposable

Parameters

dialog (IDialogPartMethodOptions) — the dialog options

Returns

(IDisposable) — the disposable object

Examples

import { Button } from '@univerjs/design';

univerAPI.openDialog({
  id: 'mock-dialog-id',
  width: 500,
  title: {
    label: 'Dialog Title',
  },
  children: {
    label: 'Dialog Content',
  },
  footer: {
    title: (
      <>
        <Button onClick={() => { console.log('Cancel clicked') }}>Cancel</Button>
        <Button variant="primary" onClick={() => { console.log('Confirm clicked') }} style={{marginLeft: '10px'}}>Confirm</Button>
      </>
    )
  },
  draggable: true,
  mask: true,
  maskClosable: true,
});

`openSiderbar`

Open a sidebar.

Deprecated use univerAPI.openSidebar instead

Signature

openSiderbar(params: ISidebarMethodOptions): IDisposable

Parameters

params (ISidebarMethodOptions) — the sidebar options

Returns

(IDisposable) — the disposable object

Examples

univerAPI.openSidebar({
  id: 'mock-sidebar-id',
  width: 300,
  header: {
    label: 'Sidebar Header',
  },
  children: {
    label: 'Sidebar Content',
  },
  footer: {
    label: 'Sidebar Footer',
  },
  onClose: () => {
    console.log('Sidebar closed')
  },
})

`showSelection`

Set selection visible.

Signature

showSelection(): FWorkbook

Returns

(FWorkbook) — FWorkbook instance for chaining

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.showSelection()

`startEditing`

Start the editing process of the current active cell

Signature

startEditing(): boolean

Returns

(boolean) — Whether the editing process is started successfully

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.startEditing()

`transparentSelection`

Set selection invisible, Unlike disableSelection, selection still works, you just can not see them.

Signature

transparentSelection(): FWorkbook

Returns

(FWorkbook) — FWorkbook instance for chaining

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.transparentSelection()

Table of Contents