API Reference

@univerjs-pro/bases-dashboard

Pivot View calculation, Dashboard persistence, commands, Worker RPC, and Facade APIs for Univer Base.

TypeScript
import { UniverBaseDashboardPlugin } from '@univerjs-pro/bases-dashboard'import '@univerjs-pro/bases-dashboard/facade'univer.registerPlugin(UniverBaseDashboardPlugin)const base = univerAPI.getActiveBase()const table = base?.getTables()[0]const pivot = table && base?.createPivotView('Revenue by region', table.getId())const dashboard = base?.createDashboard('Executive overview')

The Facade entry extends FBase with Pivot View and Dashboard creation/query APIs. FBasePivotView manages Pivot configuration and calculation; FBaseDashboard manages its widgets and layout.

Use UniverRemoteBaseDashboardPlugin in a Worker. notExecuteCalculation: true registers the main-thread RPC side, false registers the Worker calculator, and omission keeps calculation in the current thread.

Entry Points

  • Facade: @univerjs-pro/bases-dashboard/facade
  • Locale: @univerjs-pro/bases-dashboard/locale/*

How is this guide?

© 2026 DreamNum Co., Ltd.