# FBaseUI - Human documentation: [https://docs.univer.ai/reference/facade/base-ui](https://docs.univer.ai/reference/facade/base-ui) - Agent Markdown: [https://docs.univer.ai/reference/facade/base-ui.md](https://docs.univer.ai/reference/facade/base-ui.md) - Requested language: `en-US` - Content language: `en-US` - Documentation version: `1.0.0-rc.0` - Source: [facade/base-ui.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/facade/base-ui.mdx) --- ## Access Access through: * [`FUniver.getBaseUI()`](https://docs.univer.ai/reference/facade/univer.md#getbaseui) ## Setup Register [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) 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](https://docs.univer.ai/guides/bases/getting-started/facade.md). ## `@univerjs-pro/bases-ui` ### `FBaseUI.activateTable` ```typescript activateTable(tableId: string): Promise ``` **Parameters** * `tableId` — Required. **Types:** [`Promise`](https://unpkg.com/@typescript/typescript-darwin-arm64@7.0.2/lib/lib.es5.d.ts) **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.activateView` ```typescript activateView(viewId: string): Promise ``` **Parameters** * `viewId` — Required. **Types:** [`Promise`](https://unpkg.com/@typescript/typescript-darwin-arm64@7.0.2/lib/lib.es5.d.ts) **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.closeLeftSidebar` ```typescript closeLeftSidebar(): void ``` **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.closeRecordDetail` ```typescript closeRecordDetail(): void ``` **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.closeRightSidebar` ```typescript closeRightSidebar(): void ``` **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.getActiveTableId` ```typescript getActiveTableId(): string | null ``` **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.getActiveViewId` ```typescript getActiveViewId(): string | null ``` **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.getGroupOptions` ```typescript getGroupOptions(): IBasePeopleOption[] ``` **Types:** [`IBasePeopleOption`](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/components/panels/field-config/field-config-model.d.ts) **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.getPersonOptions` ```typescript getPersonOptions(): IBasePeopleOption[] ``` **Types:** [`IBasePeopleOption`](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/components/panels/field-config/field-config-model.d.ts) **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.getRenderedView` ```typescript getRenderedView(): FBaseRenderedView | null ``` **Types:** [`FBaseRenderedView`](https://docs.univer.ai/reference/facade/base-rendered-view.md) **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.getSelection` ```typescript getSelection(): BaseSelection | null ``` **Types:** [`BaseSelection`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/bases/typedef.d.ts) **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.openDraftRecordDetail` ```typescript openDraftRecordDetail(values?: Record): void ``` **Parameters** * `values` — Optional. Default: `{}`. **Types:** [`Record`](https://unpkg.com/@typescript/typescript-darwin-arm64@7.0.2/lib/lib.es5.d.ts) **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.openFieldConfigPanel` ```typescript openFieldConfigPanel(fieldId: string): void ``` **Parameters** * `fieldId` — Required. **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.openLeftSidebar` ```typescript openLeftSidebar(): void ``` **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.openRecordDetail` ```typescript openRecordDetail(recordId: string): void ``` **Parameters** * `recordId` — Required. **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.openRightSidebar` ```typescript openRightSidebar(): void ``` **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.openViewSettingsPanel` ```typescript openViewSettingsPanel(viewId: string): void ``` **Parameters** * `viewId` — Required. **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.scrollToField` ```typescript scrollToField(_fieldId: string, options?: IScrollToRecordOptions): void ``` **Parameters** * `_fieldId` — Required. * `options` — Optional. Default: `{}`. **Types:** [`IScrollToRecordOptions`](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/services/base-ui-state.service.d.ts) **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.scrollToRecord` ```typescript scrollToRecord(_recordId: string, options?: IScrollToRecordOptions): void ``` **Parameters** * `_recordId` — Required. * `options` — Optional. Default: `{}`. **Types:** [`IScrollToRecordOptions`](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/services/base-ui-state.service.d.ts) **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.setGroupOptions` ```typescript setGroupOptions(options: IBasePeopleOption[]): void ``` **Parameters** * `options` — Required. **Types:** [`IBasePeopleOption`](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/components/panels/field-config/field-config-model.d.ts) **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.setPersonOptions` ```typescript setPersonOptions(options: IBasePeopleOption[]): void ``` **Parameters** * `options` — Required. **Types:** [`IBasePeopleOption`](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/components/panels/field-config/field-config-model.d.ts) **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.setSelection` ```typescript setSelection(selection: BaseSelection | null): void ``` **Parameters** * `selection` — Required. **Types:** [`BaseSelection`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/bases/typedef.d.ts) **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.startEditingCell` ```typescript startEditingCell(input: IStartEditingCellInput): void ``` **Parameters** * `input` — Required. **Types:** [`IStartEditingCellInput`](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/services/base-editor.service.d.ts) **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts) ### `FBaseUI.stopEditingCell` ```typescript stopEditingCell(): void ``` **Package:** [`@univerjs-pro/bases-ui`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/bases-ui.md) · [Type definitions](https://unpkg.com/@univerjs-pro/bases-ui@1.0.0-rc.0/lib/types/facade/f-base-ui.d.ts)