# FSparkline

> Language fallback: requested `ko-KR`; content is `en-US`.

- Human documentation: [https://docs.univer.ai/ko-KR/reference/facade/sparkline](https://docs.univer.ai/ko-KR/reference/facade/sparkline)

- Agent Markdown: [https://docs.univer.ai/ko-KR/reference/facade/sparkline.md](https://docs.univer.ai/ko-KR/reference/facade/sparkline.md)

- Requested language: `ko-KR`

- Content language: `en-US`

- Documentation version: `1.0.4`

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

---

The facade class for the sparkline.

## Access

Access through:

* [`FWorksheet.addSparkline()`](https://docs.univer.ai/ko-KR/reference/facade/worksheet.md#addsparkline)
* [`FWorksheet.getSparklineByCell()`](https://docs.univer.ai/ko-KR/reference/facade/worksheet.md#getsparklinebycell)

## Setup

Register [`@univerjs-pro/sheets-sparkline`](https://docs.univer.ai/ko-KR/reference/packages/plugins/univerjs-pro/sheets-sparkline.md) or a preset that includes it. In plugin mode, import `@univerjs-pro/sheets-sparkline/facade`. Additional methods below require their listed plugin packages. See [Facade setup](https://docs.univer.ai/ko-KR/guides/sheets/getting-started/facade.md).

## `@univerjs-pro/sheets-sparkline`

### `FSparkline.changeDataSource`

Modify the data source of the sparkline in the current cell

```typescript
changeDataSource(sourceRange: IRange, targetRange: IRange): FSparkline | undefined
```

**Parameters**

* `sourceRange` — Required. Location of new data source
* `targetRange` — Required. New placement

**Returns**

Return this, for chaining

**Examples**

```ts
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getSheetByName('Sheet1')
if (!fWorksheet) throw new Error('fWorksheet is not available')

// Create a sparkline in the range A10, with the data source in the range A1:A7.
const sparkline = fWorksheet.addSparkline(
  [fWorksheet.getRange('A1:A7').getRange()],
  [fWorksheet.getRange('A10').getRange()],
)

// Modify the data source of the sparkline to the range B1:B7, and move it to the range B10 after 3 seconds.
setTimeout(() => {
  sparkline.changeDataSource(
    fWorksheet.getRange('B1:B7').getRange(),
    fWorksheet.getRange('B10').getRange(),
  )
}, 3000)
```

**Types:** [`FSparkline`](https://docs.univer.ai/ko-KR/reference/facade/sparkline.md) · [`IRange`](https://docs.univer.ai/ko-KR/reference/types/range.md)

**Package:** [`@univerjs-pro/sheets-sparkline`](https://docs.univer.ai/ko-KR/reference/packages/plugins/univerjs-pro/sheets-sparkline.md) · [Type definitions](https://unpkg.com/@univerjs-pro/sheets-sparkline/lib/types/facade/f-sparkline.d.ts)

### `FSparkline.removeSparkline`

Delete the sparkline in the current cell

```typescript
removeSparkline(): void
```

**Examples**

```ts
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getSheetByName('Sheet1')
if (!fWorksheet) throw new Error('fWorksheet is not available')

// Create a sparkline in the range A10, with the data source in the range A1:A7.
const sparkline = fWorksheet.addSparkline(
  [fWorksheet.getRange('A1:A7').getRange()],
  [fWorksheet.getRange('A10').getRange()],
)

// Remove the sparkline after 3 seconds.
setTimeout(() => {
  sparkline.removeSparkline()
}, 3000)
```

**Package:** [`@univerjs-pro/sheets-sparkline`](https://docs.univer.ai/ko-KR/reference/packages/plugins/univerjs-pro/sheets-sparkline.md) · [Type definitions](https://unpkg.com/@univerjs-pro/sheets-sparkline/lib/types/facade/f-sparkline.d.ts)
