# FScatterChartBuilder

- Human documentation: [https://docs.univer.ai/reference/facade/scatter-chart-builder](https://docs.univer.ai/reference/facade/scatter-chart-builder)

- Agent Markdown: [https://docs.univer.ai/reference/facade/scatter-chart-builder.md](https://docs.univer.ai/reference/facade/scatter-chart-builder.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [facade/scatter-chart-builder.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/facade/scatter-chart-builder.mdx)

---

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`](https://docs.univer.ai/reference/facade/cartesian-chart-builder.md). Its inherited members are available on this object.

## Example

Sheet

```ts
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

```ts
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

```ts
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

```ts
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)
```

## Setup

Register [`@univerjs-pro/engine-chart`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/engine-chart.md) 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](https://docs.univer.ai/guides/sheets/getting-started/facade.md).
