FCombinationChartBuilder

Fluent, type-specific Builder for mixed Column, Line, and Area Combination Charts.

Inheritance

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

Example

Sheet

TypeScript

const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Combination)  .setSource('A1:D8')  .setSeriesType(0, univerAPI.Enum.ChartSeriesTypeString.ColumnStacked)  .setSeriesType(1, univerAPI.Enum.ChartSeriesTypeString.ColumnStacked)  .setSeriesType(2, univerAPI.Enum.ChartSeriesTypeString.Line)  .setSeriesAxis(0, univerAPI.Enum.ChartSeriesAxis.Right)  .build()await fWorksheet.insertChart(chartInfo)

Doc

TypeScript

const fDocument = univerAPI.getActiveDocument()const chartInfo = fDocument  .newChart(univerAPI.Enum.ChartTypeString.Combination)  .setSource([    ['Month', 'Sales', 'Profit'],    ['Jan', 120, 24],    ['Feb', 180, 38],  ])  .setSeriesType(0, univerAPI.Enum.ChartSeriesTypeString.Line)  .setSeriesAxis(0, univerAPI.Enum.ChartSeriesAxis.Right)  .build()await fDocument.insertChart(chartInfo)

Slide

TypeScript

const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideByIndex(0)const chartInfo = fSlide  .newChart(univerAPI.Enum.ChartTypeString.Combination)  .setSource([    ['Month', 'Sales', 'Profit'],    ['Jan', 120, 24],    ['Feb', 180, 38],  ])  .setSeriesType(0, univerAPI.Enum.ChartSeriesTypeString.Line)  .setSeriesAxis(0, univerAPI.Enum.ChartSeriesAxis.Right)  .build()await fSlide.insertChart(chartInfo)

Board

TypeScript

const fBoard = univerAPI.getActiveBoard()const chartInfo = fBoard  .newChart(univerAPI.Enum.ChartTypeString.Combination)  .setSource([    ['Month', 'Sales', 'Profit'],    ['Jan', 120, 24],    ['Feb', 180, 38],  ])  .setSeriesType(0, univerAPI.Enum.ChartSeriesTypeString.Line)  .setSeriesAxis(0, univerAPI.Enum.ChartSeriesAxis.Right)  .build()await fBoard.insertChart(chartInfo)

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`

`FCombinationChartBuilder.resetSeriesAxis`

Removes the series override so the series uses the primary value axis.

This method executes synchronously.

TypeScript

resetSeriesAxis(selector: ChartPublicSeriesSelector): this

Parameters

selector — Required. The target series selector.

Returns

This builder for chaining.

Examples

TypeScript

builder.resetSeriesAxis(0)

Types: ChartPublicSeriesSelector

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

`FCombinationChartBuilder.resetSeriesType`

Removes the series override. The first series defaults to Column and later series default to Line.

This method executes synchronously.

TypeScript

resetSeriesType(selector: ChartPublicSeriesSelector): this

Parameters

selector — Required. The target series selector.

Returns

This builder for chaining.

Examples

TypeScript

builder.resetSeriesType(0)

Types: ChartPublicSeriesSelector

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

`FCombinationChartBuilder.setSeriesAxis`

Sets the series axis configuration and returns this builder for chaining.

This method executes synchronously.

TypeScript

setSeriesAxis(selector: ChartPublicSeriesSelector, value: ChartSeriesAxis): this

Parameters

selector — Required. The target series selector.
value — Required. The semantic value to record.

Returns

This builder for chaining.

Examples

TypeScript

builder.setSeriesAxis(0, univerAPI.Enum.ChartSeriesAxis.Right)

Types: ChartPublicSeriesSelector · ChartSeriesAxis

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

`FCombinationChartBuilder.setSeriesType`

Sets the series type configuration and returns this builder for chaining.

This method executes synchronously.

TypeScript

setSeriesType(selector: ChartPublicSeriesSelector, value: ChartSeriesTypeString): this

Parameters

selector — Required. The target series selector.
value — Required. The semantic value to record.

Returns

This builder for chaining.

Examples

TypeScript

builder.setSeriesType(0, univerAPI.Enum.ChartSeriesTypeString.ColumnStacked)

Types: ChartPublicSeriesSelector · ChartSeriesTypeString

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

How is this guide?