FBaseUI

Access

Access through:

• FUniver.getBaseUI()

Setup

Register @univerjs-pro/bases-ui or a preset that includes it. In plugin mode, import @univerjs-pro/bases-ui/facade. Additional methods below require their listed plugin packages. See Facade setup.

@univerjs-pro/bases-ui

FBaseUI.activateTable

activateTable(tableId: string): Promise<void>

Parameters

• tableId — Required.

Types: Promise

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.activateView

activateView(viewId: string): Promise<void>

Parameters

• viewId — Required.

Types: Promise

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.closeLeftSidebar

closeLeftSidebar(): void

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.closeRecordDetail

closeRecordDetail(): void

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.closeRightSidebar

closeRightSidebar(): void

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.getActiveTableId

getActiveTableId(): string | null

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.getActiveViewId

getActiveViewId(): string | null

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.getGroupOptions

getGroupOptions(): IBasePeopleOption[]

Types: IBasePeopleOption

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.getPersonOptions

getPersonOptions(): IBasePeopleOption[]

Types: IBasePeopleOption

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.getRenderedView

getRenderedView(): FBaseRenderedView | null

Types: FBaseRenderedView

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.getSelection

getSelection(): BaseSelection | null

Types: BaseSelection

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.openDraftRecordDetail

openDraftRecordDetail(values?: Record<string, unknown>): void

Parameters

• values — Optional. Default: {}.

Types: Record

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.openFieldConfigPanel

openFieldConfigPanel(fieldId: string): void

Parameters

• fieldId — Required.

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.openLeftSidebar

openLeftSidebar(): void

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.openRecordDetail

openRecordDetail(recordId: string): void

Parameters

• recordId — Required.

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.openRightSidebar

openRightSidebar(): void

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.openViewSettingsPanel

openViewSettingsPanel(viewId: string): void

Parameters

• viewId — Required.

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.scrollToField

scrollToField(_fieldId: string, options?: IScrollToRecordOptions): void

Parameters

• _fieldId — Required.
• options — Optional. Default: {}.

Types: IScrollToRecordOptions

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.scrollToRecord

scrollToRecord(_recordId: string, options?: IScrollToRecordOptions): void

Parameters

• _recordId — Required.
• options — Optional. Default: {}.

Types: IScrollToRecordOptions

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.setGroupOptions

setGroupOptions(options: IBasePeopleOption[]): void

Parameters

• options — Required.

Types: IBasePeopleOption

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.setPersonOptions

setPersonOptions(options: IBasePeopleOption[]): void

Parameters

• options — Required.

Types: IBasePeopleOption

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.setSelection

setSelection(selection: BaseSelection | null): void

Parameters

• selection — Required.

Types: BaseSelection

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.startEditingCell

startEditingCell(input: IStartEditingCellInput): void

Parameters

• input — Required.

Types: IStartEditingCellInput

Package: @univerjs-pro/bases-ui · Type definitions

FBaseUI.stopEditingCell

stopEditingCell(): void

Package: @univerjs-pro/bases-ui · Type definitions