API Reference

@univerjs-pro/engine-chart

Shared chart runtime for Sheets, Docs, Slides, and Boards. It owns common chart models, themes, styles, data-source utilities, and word-cloud rendering configuration.

TypeScript
import { UniverChartPlugin } from '@univerjs-pro/engine-chart'import '@univerjs-pro/engine-chart/facade'univer.registerPlugin(UniverChartPlugin, {  wordCloudRenderConfig: {    // Optional ECharts word-cloud renderer defaults.  },})

Product-specific chart plugins depend on this shared runtime. Continue registering the Sheets, Docs, Slides, or Boards chart plugin for the host you use.

The Facade entry provides shared chart builders and the live FChart API. Host facades expose newChart(type), insertChart(info), getChart(id), and getCharts(). Builders accept data through setSource(); inserted charts use setDataSource() or toBuilder() plus update(). See the Chart Facade lifecycle for a complete example.

For hierarchical labels, call setCategoryFields(indexes) in root-to-leaf order and enable setMultiLevelCategoryAxis(true). Both detached builders and live charts expose these methods. The root entry also exports IChartDataCategoryLevel, IChartDataCategorySegment, and IUniverDataSetCategorySpan for integrations that construct chart datasets directly.

IUniverChartConfig

TypeScript
export interface IUniverChartConfig {  wordCloudRenderConfig?: IWordCloudRenderConfig}

Entry Points

  • Facade: @univerjs-pro/engine-chart/facade
  • Locale: @univerjs-pro/engine-chart/locale/*

How is this guide?

© 2026 DreamNum Co., Ltd.