# 迷你圖

- Human documentation: [https://docs.univer.ai/zh-TW/guides/sheets/features/sparkline](https://docs.univer.ai/zh-TW/guides/sheets/features/sparkline)

- Agent Markdown: [https://docs.univer.ai/zh-TW/guides/sheets/features/sparkline.md](https://docs.univer.ai/zh-TW/guides/sheets/features/sparkline.md)

- Requested language: `zh-TW`

- Content language: `zh-TW`

- Documentation version: `1.2.0`

- Source: [sheets/features/sparkline.zh-TW.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/sheets/features/sparkline.zh-TW.mdx)

---

#### Package metadata

```json
{
  "mobile": true,
  "preset": [
    {
      "client": "@univerjs/preset-sheets-advanced",
      "locale": "@univerjs/preset-sheets-advanced/locales/zh-TW",
      "style": "@univerjs/preset-sheets-advanced/lib/index.css"
    }
  ],
  "plugins": [
    {
      "client": "@univerjs-pro/sheets-sparkline",
      "facade": "@univerjs-pro/sheets-sparkline/facade"
    },
    {
      "client": "@univerjs-pro/sheets-sparkline-ui",
      "locale": "@univerjs-pro/sheets-sparkline-ui/locale/zh-TW",
      "style": "@univerjs-pro/sheets-sparkline-ui/lib/index.css"
    }
  ],
  "license": true,
  "server": false
}
```

迷你圖是一種簡潔、直觀的小型圖表，通常嵌入在表格單元格中，用於快速展示資料趨勢或關鍵指標。

## 外掛模式

### 安裝

#### npm

```bash
npm install @univerjs-pro/sheets-sparkline @univerjs-pro/sheets-sparkline-ui
```

#### pnpm

```bash
pnpm add @univerjs-pro/sheets-sparkline @univerjs-pro/sheets-sparkline-ui
```

#### yarn

```bash
yarn add @univerjs-pro/sheets-sparkline @univerjs-pro/sheets-sparkline-ui
```

#### bun

```bash
bun add @univerjs-pro/sheets-sparkline @univerjs-pro/sheets-sparkline-ui
```

### 使用

```typescript
import { UniverSheetSparklinePlugin } from '@univerjs-pro/sheets-sparkline' // [!code ++]
import { UniverSheetSparklineUIPlugin } from '@univerjs-pro/sheets-sparkline-ui' // [!code ++]
import SheetsSparklineUIZhTW from '@univerjs-pro/sheets-sparkline-ui/locale/zh-TW' // [!code ++]
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'

import '@univerjs-pro/sheets-sparkline/facade' // [!code ++]

import '@univerjs-pro/sheets-sparkline-ui/lib/index.css' // [!code ++]

const univer = new Univer({
  locale: LocaleType.ZH_TW,
  locales: {
    [LocaleType.ZH_TW]: mergeLocales(
      SheetsSparklineUIZhTW, // [!code ++]
    ),
  },
})

univer.registerPlugin(UniverSheetSparklinePlugin)
univer.registerPlugin(UniverSheetSparklineUIPlugin)
```

如果你擁有 Univer 的商業許可證，請參考[在客戶端使用許可證](https://docs.univer.ai/zh-TW/server/license.md#in-plugin-mode)進行配置。

## 行動裝置支援

先設定[行動版編輯器](https://docs.univer.ai/zh-TW/guides/sheets/getting-started/installation.md#mobile-support)。在本頁外掛模式的初始化程式碼中，將下列桌面版註冊替換為同一套件匯出的行動版外掛，並在**開啟文件前**完成。保留模型外掛、樣式、語言套件與 Facade 匯入，請勿同時註冊兩個版本。

| 套件                                  | 桌面版註冊                          | 行動版註冊                                |
| ----------------------------------- | ------------------------------ | ------------------------------------ |
| `@univerjs-pro/sheets-sparkline-ui` | `UniverSheetSparklineUIPlugin` | `UniverSheetSparklineMobileUIPlugin` |

## 預設模式

迷你圖功能被包含在 `@univerjs/preset-sheets-advanced` 預設中。

### 安裝

> [!NOTE]
> @univerjs/preset-sheets-advanced 的 `UniverSheetsAdvancedPreset` 預設在執行時依賴 `UniverSheetsDrawingPreset` 預設，請先安裝 @univerjs/preset-sheets-drawing。

#### npm

```bash
npm install @univerjs/preset-sheets-drawing @univerjs/preset-sheets-advanced
```

#### pnpm

```bash
pnpm add @univerjs/preset-sheets-drawing @univerjs/preset-sheets-advanced
```

#### yarn

```bash
yarn add @univerjs/preset-sheets-drawing @univerjs/preset-sheets-advanced
```

#### bun

```bash
bun add @univerjs/preset-sheets-drawing @univerjs/preset-sheets-advanced
```

### 使用

```typescript
import { UniverSheetsAdvancedPreset } from '@univerjs/preset-sheets-advanced' // [!code ++]
import UniverPresetSheetsAdvancedZhTW from '@univerjs/preset-sheets-advanced/locales/zh-TW' // [!code ++]
import { UniverSheetsCorePreset } from '@univerjs/preset-sheets-core'
import UniverPresetSheetsCoreZhTW from '@univerjs/preset-sheets-core/locales/zh-TW'
import { UniverSheetsDrawingPreset } from '@univerjs/preset-sheets-drawing' // [!code ++]
import UniverPresetSheetsDrawingZhTW from '@univerjs/preset-sheets-drawing/locales/zh-TW' // [!code ++]
import { createUniver, LocaleType, mergeLocales } from '@univerjs/presets'

import '@univerjs/preset-sheets-core/lib/index.css'
import '@univerjs/preset-sheets-drawing/lib/index.css' // [!code ++]
import '@univerjs/preset-sheets-advanced/lib/index.css' // [!code ++]

const { univerAPI } = createUniver({
  locale: LocaleType.ZH_TW,
  locales: {
    [LocaleType.ZH_TW]: mergeLocales(
      UniverPresetSheetsCoreZhTW,
      UniverPresetSheetsDrawingZhTW, // [!code ++]
      UniverPresetSheetsAdvancedZhTW, // [!code ++]
    ),
  },
  presets: [
    UniverSheetsCorePreset(),
    UniverSheetsDrawingPreset(), // [!code ++]
    UniverSheetsAdvancedPreset(), // [!code ++]
  ],
})
```

如果你擁有 Univer 的商業許可證，請參考[在客戶端使用許可證](https://docs.univer.ai/zh-TW/server/license.md#in-preset-mode)進行配置。

## Facade API

### 引入

> [!INFO: 外掛模式提示]
> 僅外掛模式需要手動引入 Facade 套件。預設模式已內建對應的 Facade 套件，無需額外引入。

```typescript
import '@univerjs-pro/sheets-sparkline/facade'
```

### 新增迷你圖

[`FWorksheet.addSparkline`](https://docs.univer.ai/zh-TW/reference/facade/worksheet.md#addsparkline) 方法用於在指定區域新增迷你圖，返回一個 `FSparkline` 例項。

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// 建立一個迷你圖，資料來源為 A1:A7，放置在 A10 單元格中。
const sourceRanges = [fWorksheet.getRange('A1:A7').getRange()]
const targetRanges = [fWorksheet.getRange('A10').getRange()]
const sparkline = fWorksheet.addSparkline(sourceRanges, targetRanges, univerAPI.Enum.SparklineTypeEnum.LINE_CHART)
```

### 組合迷你圖和取消組合迷你圖

[`FWorksheet.composeSparkline`](https://docs.univer.ai/zh-TW/reference/facade/worksheet.md#composesparkline) 和 [`FWorksheet.unComposeSparkline`](https://docs.univer.ai/zh-TW/reference/facade/worksheet.md#uncomposesparkline) 方法用於組合和取消組合迷你圖。

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// 建立一個迷你圖，資料來源為 A1:A7，放置在 A10 單元格中。
const firstSparkline = fWorksheet.addSparkline(
  [fWorksheet.getRange('A1:A7').getRange()],
  [fWorksheet.getRange('A10').getRange()],
)

// 建立一個迷你圖，資料來源為 B1:B7，放置在 B10 單元格中。
const secondSparkline = fWorksheet.addSparkline(
  [fWorksheet.getRange('B1:B7').getRange()],
  [fWorksheet.getRange('B10').getRange()],
)

// 將兩個迷你圖組合成一個迷你圖組
fWorksheet.composeSparkline([fWorksheet.getRange('A10:B10').getRange()])
console.log(fWorksheet.getAllSubSparkline().size) // 1

// 3 秒後取消組合迷你圖組
setTimeout(() => {
  fWorksheet.unComposeSparkline([fWorksheet.getRange('A10:B10').getRange()])
  console.log(fWorksheet.getAllSubSparkline().size) // 2
}, 3000)
```

### 獲取迷你圖和迷你圖組例項

[`FWorksheet.getSparklineByCell`](https://docs.univer.ai/zh-TW/reference/facade/worksheet.md#getsparklinebycell) 用於獲取指定單元格內的迷你圖例項，返回一個 `FSparkline` 例項。

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// 建立一個迷你圖，資料來源為 A1:A7，放置在 A10 單元格中。
const sourceRanges = [fWorksheet.getRange('A1:A7').getRange()]
const targetRanges = [fWorksheet.getRange('A10').getRange()]
const sparkline = fWorksheet.addSparkline(sourceRanges, targetRanges)

console.log('Cell A10: ', fWorksheet.getSparklineByCell(9, 0))
console.log('Cell A11: ', fWorksheet.getSparklineByCell(10, 0))
```

[`FWorksheet.getSparklineGroupByCell`](https://docs.univer.ai/zh-TW/reference/facade/worksheet.md#getsparklinegroupbycell) 用於獲取指定單元格內的迷你圖組例項，返回一個 `FSparklineGroup` 例項。

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// 建立一個迷你圖，資料來源為 A1:A7，放置在 A10 單元格中。
const firstSparkline = fWorksheet.addSparkline(
  [fWorksheet.getRange('A1:A7').getRange()],
  [fWorksheet.getRange('A10').getRange()],
)

// 建立一個迷你圖，資料來源為 B1:B7，放置在 B10 單元格中。
const secondSparkline = fWorksheet.addSparkline(
  [fWorksheet.getRange('B1:B7').getRange()],
  [fWorksheet.getRange('B10').getRange()],
)
console.log('Cell A10: ', fWorksheet.getSparklineGroupByCell(9, 0))

// 3 秒後將兩個迷你圖組合成一個迷你圖組
setTimeout(() => {
  fWorksheet.composeSparkline([fWorksheet.getRange('A10:B10').getRange()])
  console.log('Cell A10: ', fWorksheet.getSparklineGroupByCell(9, 0))
}, 3000)
```

[`FSparkline`](https://docs.univer.ai/zh-TW/reference/facade/sparkline.md) 例項有以下方法用來操作迷你圖：

| 方法               | 描述                    |
| ---------------- | --------------------- |
| changeDataSource | 修改當前單元格內迷你圖的資料來源和放置位置 |
| removeSparkline  | 刪除當前單元格內的迷你圖          |

[`FSparklineGroup`](https://docs.univer.ai/zh-TW/reference/facade/sparkline-group.md) 例項有以下方法用來操作迷你圖組：

| 方法                   | 描述                     |
| -------------------- | ---------------------- |
| changeDataSource     | 修改當前單元格內迷你圖組的資料來源和放置位置 |
| removeSparklineGroup | 刪除當前單元格內的迷你圖所在的迷你圖組    |
| setConfig            | 更改當前單元格內的迷你圖所在的迷你圖組的配置 |

### 事件監聽

完整事件型別定義，請檢視 [Events](https://docs.univer.ai/zh-TW/reference/facade/events.md)。

`univerAPI.Event.SheetSparklineChanged` 事件在迷你圖發生變化時觸發。

```typescript
const disposable = univerAPI.addEvent(univerAPI.Event.SheetSparklineChanged, (params) => {
  const { workbook, worksheet, sparklines } = params
})

// 移除事件監聽器，使用 `disposable.dispose()`
```

## 顏色與顯示選項

迷你圖的顏色等視覺選項透過 `FSparklineGroup.setConfig()` 設定，並非獨立的 `FSparkline.setColor()` 方法。設定會套用至整個迷你圖群組。自訂顏色時，需同時設定 `seriesColor` 與 `themeType: SparklineThemeTypeEnum.CUSTOM`。顏色、標記點、座標軸、最大／最小值、空值、隱藏儲存格、線寬等完整選項及範例，請參閱[迷你圖群組設定](https://docs.univer.ai/zh-TW/reference/facade/sparkline-group.md)。