API Reference

FBaseRenderedView

Access

Access through:

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

FBaseRenderedView.getViewId

Returns the id of the view represented by this render facade.

TypeScript
getViewId(): string

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

FBaseRenderedView.getViewport

Currently returns a placeholder viewport with zero x, y, width, and height; it does not measure the rendered view.

TypeScript
getViewport(): IBaseViewport

Types: IBaseViewport

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

FBaseRenderedView.getViewType

Returns the view type supplied when this render facade was created.

TypeScript
getViewType(): BaseViewType

Types: BaseViewType

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

FBaseRenderedView.hitTest

Returns the public hit target at a point in the rendered view. Attachment controls are reported as grid cells; internal add-row, add-field, and Gantt toolbar targets return null.

TypeScript
hitTest(x: number, y: number): BaseHitTestResult | null

Parameters

  • x — Required.
  • y — Required.

Types: BaseHitTestResult

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

FBaseRenderedView.refresh

Invalidates the view controller so its render layers are rebuilt.

TypeScript
refresh(): void

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

How is this guide?

© 2026 DreamNum Co., Ltd.