FScatterChartBuilder

Fluent, type-specific Builder for Scatter Charts.

Scatter uses the ordinary Cartesian category/value mapping. Select the optional X-axis field with setCategoryField() and every Y/value series with setValueFields().

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.Scatter)  .setSource({    range: 'A1:C8',    orientation: univerAPI.Enum.ChartSourceOrientation.Columns,  })  .setCategoryField(0)  .setValueFields([1, 2])  .build()await fWorksheet.insertChart(chartInfo)

Doc

TypeScript

const fDocument = univerAPI.getActiveDocument()const chartInfo = fDocument  .newChart(univerAPI.Enum.ChartTypeString.Scatter)  .setSource([    ['X', 'Y'],    [10, 20],    [18, 32],    [24, 28],  ])  .setCategoryField(0)  .setValueFields([1])  .build()await fDocument.insertChart(chartInfo)

Slide

TypeScript

const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideByIndex(0)const chartInfo = fSlide  .newChart(univerAPI.Enum.ChartTypeString.Scatter)  .setSource([    ['X', 'Y'],    [10, 20],    [18, 32],    [24, 28],  ])  .setCategoryField(0)  .setValueFields([1])  .build()await fSlide.insertChart(chartInfo)

Board

TypeScript

const fBoard = univerAPI.getActiveBoard()const chartInfo = fBoard  .newChart(univerAPI.Enum.ChartTypeString.Scatter)  .setSource([    ['X', 'Y'],    [10, 20],    [18, 32],    [24, 28],  ])  .setCategoryField(0)  .setValueFields([1])  .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.

How is this guide?

Inheritance

Example

Setup