# Sparkline

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

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

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

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

---

| Packages | `@univerjs-pro/sheets-sparkline` |
| -------- | -------------------------------- |

The facade class for the sparkline.

> This class should not be instantiated directly. Use factory methods on `univerAPI` instead.

## Overview

### @univerjs-pro/sheets-sparkline

| Method                                          | Description |
| ----------------------------------------------- | ----------- |
| [`changeDataSource`](#changedatasource)         | -           |
| [`removeSparkline`](#removesparkline)           | -           |
| [`removeSparklineGroup`](#removesparklinegroup) | -           |
| [`setConfig`](#setconfig)                       | -           |

## APIs

### Setters & Modifiers

### `changeDataSource`

**Signature**

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

**Parameters**

* `sourceRange` `IRange` — *No description*
* `targetRange` `IRange` — *No description*

**Returns**

* `FSparkline` — Return this, for chaining

**Examples**

```ts
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();

// 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);
```

Source: 

`@univerjs-pro/sheets-sparkline`

### `setConfig`

**Signature**

```typescript
setConfig(config: ISparklineGroupConfig): FSparklineGroup
```

**Parameters**

* `config` `ISparklineGroupConfig` — *No description*

**Returns**

* `FSparklineGroup` — Return this instance, for chaining

**Examples**

```ts
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();

// 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()]
);

// Get sparkline group by cell A10
const sparklineGroup = fWorksheet.getSparklineGroupByCell(9, 0);

// Set sparkline type to bar chart after 3 seconds
setTimeout(() => {
  sparklineGroup.setConfig({
    type: univerAPI.Enum.SparklineTypeEnum.BAR_CHART
  });
}, 3000);
```

Source: 

`@univerjs-pro/sheets-sparkline`

### Actions & Operations

### `removeSparkline`

**Signature**

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

**Examples**

```ts
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();

// 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);
```

Source: 

`@univerjs-pro/sheets-sparkline`

### `removeSparklineGroup`

**Signature**

```typescript
removeSparklineGroup(): void
```

**Examples**

```ts
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();

// 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()]
);

// Get sparkline group by cell A10
const sparklineGroup = fWorksheet.getSparklineGroupByCell(9, 0);

setTimeout(() => {
  // Remove sparkline group after 3 seconds.
  sparklineGroup.removeSparklineGroup();
}, 3000);
```

Source: 

`@univerjs-pro/sheets-sparkline`