API Reference

FAxisThreeDChartBuilder

Axis-based 3D charts expose primary axes and series styling, without secondary axes or trendlines.

Inheritance

Extends FThreeDChartBuilder. Its inherited members are available on this object.

Setup

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

@univerjs-pro/engine-chart

FAxisThreeDChartBuilder.clearAllSeriesOverrides

TypeScript
clearAllSeriesOverrides(): this

Package: @univerjs-pro/engine-chart · Type definitions

FAxisThreeDChartBuilder.clearAllSeriesStyle

TypeScript
clearAllSeriesStyle(): this

Package: @univerjs-pro/engine-chart · Type definitions

FAxisThreeDChartBuilder.clearDepthAxis

Clears the depth-axis configuration without removing the 3D chart view.

TypeScript
clearDepthAxis(): this

Returns

This builder for chaining.

Examples

TypeScript
builder.clearDepthAxis()

Package: @univerjs-pro/engine-chart · Type definitions

FAxisThreeDChartBuilder.clearSeries

TypeScript
clearSeries(selector: ChartPublicSeriesSelector): this

Parameters

  • selector — Required.

Types: ChartPublicSeriesSelector

Package: @univerjs-pro/engine-chart · Type definitions

FAxisThreeDChartBuilder.clearXAxis

TypeScript
clearXAxis(target?: ChartAxisTarget): this

Parameters

  • target — Optional.

Types: ChartAxisTarget

Package: @univerjs-pro/engine-chart · Type definitions

FAxisThreeDChartBuilder.clearYAxis

TypeScript
clearYAxis(target?: ChartAxisTarget): this

Parameters

  • target — Optional.

Types: ChartAxisTarget

Package: @univerjs-pro/engine-chart · Type definitions

FAxisThreeDChartBuilder.setAllSeriesStyle

TypeScript
setAllSeriesStyle(value: DeepNullish<Pick<IChartSeriesStyleSpec, 'color' | 'fillOpacity' | 'border' | 'label'>>): this

Parameters

  • value — Required.

Types: DeepNullish · Pick · IChartSeriesStyleSpec

Package: @univerjs-pro/engine-chart · Type definitions

FAxisThreeDChartBuilder.setDepthAxis

Sets the categorical series-depth axis style; it has no numeric min, max, or format.

TypeScript
setDepthAxis(value: DeepNullish<IChartDepthAxisSpec>): this

Parameters

  • value — Required. The depth-axis title, direction, line, tick, label, or grid-line style.

Returns

This builder for chaining.

Examples

TypeScript
builder.setDepthAxis({ title: 'Region', label: { visible: true } })

Types: DeepNullish · IChartDepthAxisSpec

Package: @univerjs-pro/engine-chart · Type definitions

FAxisThreeDChartBuilder.setSeries

TypeScript
setSeries(selector: ChartPublicSeriesSelector, value: DeepNullish<Pick<IChartSeriesPatch, 'color' | 'fillOpacity' | 'border' | 'label'> & { dataPoints?: Record<number, Pick<IChartSeriesDataPointStyleSpec, 'color' | 'fillOpacity'>>; }>): this

Parameters

  • selector — Required.
  • value — Required.

Types: ChartPublicSeriesSelector · DeepNullish · Pick · IChartSeriesPatch · Record · IChartSeriesDataPointStyleSpec

Package: @univerjs-pro/engine-chart · Type definitions

FAxisThreeDChartBuilder.setXAxis

TypeScript
setXAxis(value: IChartAxisSpec): this

Parameters

  • value — Required.

Types: IChartAxisSpec

Package: @univerjs-pro/engine-chart · Type definitions

FAxisThreeDChartBuilder.setYAxis

TypeScript
setYAxis(value: IChartAxisSpec): this

Parameters

  • value — Required.

Types: IChartAxisSpec

Package: @univerjs-pro/engine-chart · Type definitions

How is this guide?

© 2026 DreamNum Co., Ltd.