# 條件格式

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

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

- Requested language: `zh-TW`

- Content language: `zh-TW`

- Documentation version: `1.2.0`

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

---

#### Package metadata

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

條件格式功能允許使用者根據特定條件自動更改單元格的格式，以便突出顯示重要資料或趨勢。它支援多種條件和格式設定選項，幫助使用者更直觀地理解資料。

## 外掛模式

### 安裝

#### npm

```bash
npm install @univerjs/sheets-conditional-formatting @univerjs/sheets-conditional-formatting-ui
```

#### pnpm

```bash
pnpm add @univerjs/sheets-conditional-formatting @univerjs/sheets-conditional-formatting-ui
```

#### yarn

```bash
yarn add @univerjs/sheets-conditional-formatting @univerjs/sheets-conditional-formatting-ui
```

#### bun

```bash
bun add @univerjs/sheets-conditional-formatting @univerjs/sheets-conditional-formatting-ui
```

### 使用

```typescript
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import { UniverSheetsConditionalFormattingPlugin } from '@univerjs/sheets-conditional-formatting' // [!code ++]
import { UniverSheetsConditionalFormattingUIPlugin } from '@univerjs/sheets-conditional-formatting-ui' // [!code ++]
import SheetsConditionalFormattingUIZhTW from '@univerjs/sheets-conditional-formatting-ui/locale/zh-TW' // [!code ++]

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

import '@univerjs/sheets-conditional-formatting/facade' // [!code ++]

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

univer.registerPlugin(UniverSheetsConditionalFormattingPlugin) // [!code ++]
univer.registerPlugin(UniverSheetsConditionalFormattingUIPlugin) // [!code ++]
```

## 行動裝置支援

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

| 套件                                           | 桌面版註冊                                       | 行動版註冊                                             |
| -------------------------------------------- | ------------------------------------------- | ------------------------------------------------- |
| `@univerjs/sheets-conditional-formatting-ui` | `UniverSheetsConditionalFormattingUIPlugin` | `UniverSheetsConditionalFormattingMobileUIPlugin` |

## 預設模式

### 安裝

#### npm

```bash
npm install @univerjs/preset-sheets-conditional-formatting
```

#### pnpm

```bash
pnpm add @univerjs/preset-sheets-conditional-formatting
```

#### yarn

```bash
yarn add @univerjs/preset-sheets-conditional-formatting
```

#### bun

```bash
bun add @univerjs/preset-sheets-conditional-formatting
```

### 使用

```typescript
import { UniverSheetsConditionalFormattingPreset } from '@univerjs/preset-sheets-conditional-formatting' // [!code ++]
import UniverPresetSheetsConditionalFormattingZhTW from '@univerjs/preset-sheets-conditional-formatting/locales/zh-TW' // [!code ++]
import { UniverSheetsCorePreset } from '@univerjs/preset-sheets-core'
import UniverPresetSheetsCoreZhTW from '@univerjs/preset-sheets-core/locales/zh-TW'
import { createUniver, LocaleType, mergeLocales } from '@univerjs/presets'

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

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

## Facade API

完整 Facade API 型別定義，請檢視 [FacadeAPI](https://docs.univer.ai/zh-TW/reference/facade/univer.md)

### 引入

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

```typescript
import '@univerjs/sheets-conditional-formatting/facade'
```

### 建立條件格式規則

[`FWorksheet.newConditionalFormattingRule()`](https://docs.univer.ai/zh-TW/reference/facade/worksheet.md#newconditionalformattingrule) 建立一個條件格式構建器，返回一個 `FConditionalFormattingBuilder` 例項，可以透過鏈式呼叫生成條件格式規則。

以下是 [`FConditionalFormattingBuilder`](https://docs.univer.ai/zh-TW/reference/facade/conditional-formatting-builder.md) 上的一些成員方法：

| 方法                             | 描述                               |
| ------------------------------ | -------------------------------- |
| build                          | 構建條件格式規則                         |
| copy                           | 深拷貝目前構建器                         |
| createCfId                     | 建立條件格式 ID                        |
| getRanges                      | 取得目前條件格式的範圍                      |
| setRanges                      | 設定條件格式規則應用的範圍                    |
| setAverage                     | 設定平均值條件格式規則                      |
| setUniqueValues                | 設定唯一值條件格式規則                      |
| setDuplicateValues             | 設定重複值條件格式規則                      |
| setRank                        | 設定排名條件格式規則                       |
| setIconSet                     | 設定圖示集條件格式規則                      |
| setColorScale                  | 設定色階條件格式規則                       |
| setDataBar                     | 設定資料條條件格式規則                      |
| setBackground                  | 設定條件格式的背景色                       |
| setBold                        | 設定條件格式的字型是否加粗                    |
| setFontColor                   | 設定條件格式的字型顏色                      |
| setItalic                      | 設定條件格式的字型是否斜體                    |
| setStrikethrough               | 設定條件格式的字型是否有刪除線                  |
| setUnderline                   | 設定條件格式的字型是否有下劃線                  |
| whenCellEmpty                  | 設定條件格式規則在單元格為空時觸發                |
| whenCellNotEmpty               | 設定條件格式規則在單元格非空時觸發                |
| whenDate                       | 設定條件格式規則在日期為滿足特定時間段時觸發           |
| whenFormulaSatisfied           | 設定條件格式規則在公式計算結果為 true 時觸發        |
| whenNumberBetween              | 設定條件格式規則在數字介於兩個指定值之間或等於其中一個值時觸發  |
| whenNumberEqualTo              | 設定條件格式規則在數字等於給定值時觸發              |
| whenNumberGreaterThan          | 設定條件格式規則在數字大於給定值時觸發              |
| whenNumberGreaterThanOrEqualTo | 設定條件格式規則在數字大於或等於給定值時觸發           |
| whenNumberLessThan             | 設定條件格式規則在數字小於給定值時觸發              |
| whenNumberLessThanOrEqualTo    | 設定條件格式規則在數字小於或等於給定值時觸發           |
| whenNumberNotBetween           | 設定條件格式規則在數字不介於兩個指定值之間且不等於這兩個值時觸發 |
| whenNumberNotEqualTo           | 設定條件格式規則在數字不等於給定值時觸發             |
| whenTextContains               | 設定條件格式規則在文字包含指定值時觸發              |
| whenTextDoesNotContain         | 設定條件格式規則在文字不包含指定值時觸發             |
| whenTextEndsWith               | 設定條件格式規則在文字以指定值結尾時觸發             |
| whenTextEqualTo                | 設定條件格式規則在文字等於給定值時觸發              |
| whenTextStartsWith             | 設定條件格式規則在文字以指定值開頭時觸發             |

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

// 建立一個條件格式規則，使範圍 A1:T100 中的非空單元格字型變為斜體，背景色為紅色，字型顏色為綠色
const fRange = fWorksheet.getRange('A1:T100')
const rule = fWorksheet.newConditionalFormattingRule()
  .whenCellNotEmpty()
  .setRanges([fRange.getRange()])
  .setItalic(true)
  .setBackground('red')
  .setFontColor('green')
  .build()
fWorksheet.addConditionalFormattingRule(rule)
```

### 獲取條件格式規則

* `FWorksheet.getConditionalFormattingRules()` 獲取工作表的所有條件格式規則
* `FRange.getConditionalFormattingRules()` 獲取範圍的所有條件格式規則

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

// 獲取活動工作表的所有條件格式規則
const fWorksheet = fWorkbook.getActiveSheet()
const rulesOfSheet = fWorksheet.getConditionalFormattingRules()

// 獲取範圍 A1:T100 的所有條件格式規則
const fRange = fWorksheet.getRange('A1:T100')
const rulesOfRange = fRange.getConditionalFormattingRules()
```

### 刪除條件格式規則

`FWorksheet.deleteConditionalFormattingRule(cfId)` 方法可以刪除工作表的條件格式規則，`cfId` 為條件格式規則的 id。

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

// 刪除第一個規則
fWorksheet.deleteConditionalFormattingRule(rules[0]?.cfId)
```

### 更新條件格式規則

`FWorksheet.setConditionalFormattingRule(cfId, rule)` 方法可以更新工作表的條件格式規則，`cfId` 為條件格式規則的 id，`rule` 為新的條件格式規則。

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

// 建立一個條件格式規則，使非空單元格字型變為斜體，背景色為紅色，字型顏色為綠色
const fRange = fWorksheet.getRange('A1:T100')
const rule = fWorksheet.newConditionalFormattingRule()
  .whenCellNotEmpty()
  .setRanges([fRange.getRange()])
  .setItalic(true)
  .setBackground('red')
  .setFontColor('green')
  .build()
fWorksheet.addConditionalFormattingRule(rule)

// 修改第一個規則應用到新的範圍
const rules = fWorksheet.getConditionalFormattingRules()
const newRuleRange = fWorksheet.getRange('A1:D10')
fWorksheet.setConditionalFormattingRule(rules[0]?.cfId, { ...rules[0], ranges: [newRuleRange.getRange()] })
```

### 修改條件格式規則的優先順序

`FWorksheet.moveConditionalFormattingRule(cfId, toCfId, type)` 方法可以修改工作表的條件格式規則的優先順序，`cfId` 為條件格式規則的 id，`toCfId` 為目標條件格式規則的 id，`type` 為移動型別。

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

// 移動第三個規則到第一個規則之前
const rule = rules[2]
const targetRule = rules[0]
fWorksheet.moveConditionalFormattingRule(rule?.cfId, targetRule?.cfId, 'before')
```

### 清除所有條件格式規則

* `FWorksheet.clearConditionalFormatRules()` 清除工作表的所有條件格式規則
* `FRange.clearConditionalFormatRules()` 清除範圍的所有條件格式規則

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

// 清除活動工作表的所有條件格式規則
const fWorksheet = fWorkbook.getActiveSheet()
fWorksheet.clearConditionalFormatRules()

// 清除範圍 A1:T100 的所有條件格式規則
const fRange = fWorksheet.getRange('A1:T100')
fRange.clearConditionalFormatRules()
```

## 重用規則描述與預覽

自訂規則清單時，可從 `@univerjs/sheets-conditional-formatting-ui` 匯入 `getRuleDescribe` 和 `ConditionalFormattingRulePreview`。前者接收完整規則 `getRuleDescribe(rule, localeService)`，後者只接收規則設定 `rule.rule`。預覽顯示設定的外觀，不會計算工作表儲存格的實際結果；請在 Univer 的 React 上下文中呈現。

`CF_PANEL_KEY` 是內建面板的[元件覆寫識別碼](https://docs.univer.ai/zh-TW/guides/sheets/ui/components.md)。面板屬性 `IConditionFormattingPanelProps.onEditorExit` 在提交、取消或工作表啟用／移除導致編輯結束時觸發，不代表儲存成功，也不代表側邊欄關閉。

```tsx
import type { IConditionFormattingRule } from '@univerjs/sheets-conditional-formatting'
import { LocaleService } from '@univerjs/core'
import { ConditionalFormattingRulePreview, getRuleDescribe } from '@univerjs/sheets-conditional-formatting-ui'
import { useDependency } from '@univerjs/ui'

interface IRuleSummaryProps {
  rule: IConditionFormattingRule
}

function RuleSummary({ rule }: IRuleSummaryProps) {
  const localeService = useDependency(LocaleService)

  return (
    <div>
      <span>{getRuleDescribe(rule, localeService)}</span>
      <ConditionalFormattingRulePreview rule={rule.rule} />
    </div>
  )
}
```