# 条件付き書式

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

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

- Requested language: `ja-JP`

- Content language: `ja-JP`

- Documentation version: `1.1.0`

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

---

#### Package metadata

```json
{
  "preset": [
    {
      "client": "@univerjs/preset-sheets-conditional-formatting",
      "locale": "@univerjs/preset-sheets-conditional-formatting/locales/ja-JP",
      "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/ja-JP",
      "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 SheetsConditionalFormattingUIJaJP from '@univerjs/sheets-conditional-formatting-ui/locale/ja-JP' // [!code ++]
import '@univerjs/sheets-conditional-formatting-ui/lib/index.css' // [!code ++]
import '@univerjs/sheets-conditional-formatting/facade' // [!code ++]

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

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

## モバイル対応

まず[モバイルエディター](https://docs.univer.ai/ja-JP/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 UniverPresetSheetsConditionalFormattingJaJP from '@univerjs/preset-sheets-conditional-formatting/locales/ja-JP' // [!code ++]
import { UniverSheetsCorePreset } from '@univerjs/preset-sheets-core'
import UniverPresetSheetsCoreJaJP from '@univerjs/preset-sheets-core/locales/ja-JP'
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.JA_JP,
  locales: {
    [LocaleType.JA_JP]: mergeLocales(
      UniverPresetSheetsCoreJaJP,
      UniverPresetSheetsConditionalFormattingJaJP, // [!code ++]
    ),
  },
  presets: [
    UniverSheetsCorePreset(),
    UniverSheetsConditionalFormattingPreset(), // [!code ++]
  ],
})
```

## Facade API

Facade API の完全な型定義は、[FacadeAPI](https://docs.univer.ai/ja-JP/reference/facade.md) で確認できます。

### インポート

> [!INFO: プラグインモード注意]
> Facade パッケージの手動 import が必要なのはプラグインモードのみです。プリセットモードには対応する Facade パッケージが内蔵されているため、追加の import は不要です。

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

### 条件付き書式ルールの作成

[`FWorksheet.newConditionalFormattingRule()`](https://docs.univer.ai/ja-JP/reference/facade/worksheet.md#newconditionalformattingrule) は条件付き書式ビルダーを生成し、`FConditionalFormattingBuilder` インスタンスを返します。返されたビルダーをメソッドチェーンで操作して条件付き書式ルールを作成できます。

以下は [`FConditionalFormattingBuilder`](https://docs.univer.ai/ja-JP/reference/facade/conditional-formatting-builder.md) のメソッドの一部です:

| Method                         | Description                                             |
| ------------------------------ | ------------------------------------------------------- |
| build                          | 条件付き書式ルールを構築します                                         |
| copy                           | 現在のビルダーを深くクローンします                                       |
| createCfId                     | 条件付き書式 ID を作成します                                        |
| getRanges                      | 現在の条件付き書式の範囲を取得します                                      |
| setRanges                      | 条件付き書式ルールの対象範囲を設定します                                    |
| setAverage                     | 平均値に基づく条件付き書式を設定します                                     |
| setUniqueValues                | 一意の値に対する条件付き書式を設定します                                    |
| setDuplicateValues             | 重複値に対する条件付き書式を設定します                                     |
| setRank                        | ランキングに基づく条件付き書式を設定します                                   |
| setIconSet                     | アイコンセットの条件付き書式を設定します                                    |
| setColorScale                  | カラースケールの条件付き書式を設定します                                    |
| setDataBar                     | データバーの条件付き書式を設定します                                      |
| setBackground                  | 条件付き書式の背景色を設定します                                        |
| setBold                        | 条件付き書式のフォントを太字にするかを設定します                                |
| setFontColor                   | 条件付き書式のフォント色を設定します                                      |
| setItalic                      | 条件付き書式のフォントを斜体にするかを設定します                                |
| setStrikethrough               | 条件付き書式のフォントに取り消し線を設定するかを設定します                           |
| setUnderline                   | 条件付き書式のフォントに下線を設定するかを設定します                              |
| whenCellEmpty                  | セルが空のときにトリガーする条件付き書式ルールを設定します                           |
| whenCellNotEmpty               | セルが空でないときにトリガーする条件付き書式ルールを設定します                         |
| whenDate                       | 日付が特定の期間内にあるときにトリガーする条件付き書式ルールを設定します                    |
| whenFormulaSatisfied           | 数式の評価結果が真のときにトリガーする条件付き書式ルールを設定します                      |
| whenNumberBetween              | 数値が指定した 2 つの値の間、またはそのいずれかと等しいときにトリガーする条件付き書式ルールを設定します   |
| whenNumberEqualTo              | 数値が指定した値と等しいときにトリガーする条件付き書式ルールを設定します                    |
| whenNumberGreaterThan          | 数値が指定した値より大きいときにトリガーする条件付き書式ルールを設定します                   |
| whenNumberGreaterThanOrEqualTo | 数値が指定した値以上のときにトリガーする条件付き書式ルールを設定します                     |
| whenNumberLessThan             | 数値が指定した値より小さいときにトリガーする条件付き書式ルールを設定します                   |
| whenNumberLessThanOrEqualTo    | 数値が指定した値以下のときにトリガーする条件付き書式ルールを設定します                     |
| whenNumberNotBetween           | 数値が指定した 2 つの値の間にない、かつどちらとも等しくないときにトリガーする条件付き書式ルールを設定します |
| whenNumberNotEqualTo           | 数値が指定した値と等しくないときにトリガーする条件付き書式ルールを設定します                  |
| whenTextContains               | テキストが指定した値を含むときにトリガーする条件付き書式ルールを設定します                   |
| whenTextDoesNotContain         | テキストが指定した値を含まないときにトリガーする条件付き書式ルールを設定します                 |
| whenTextEndsWith               | テキストが指定した値で終わるときにトリガーする条件付き書式ルールを設定します                  |
| whenTextEqualTo                | テキストが指定した値と等しいときにトリガーする条件付き書式ルールを設定します                  |
| whenTextStartsWith             | テキストが指定した値で始まるときにトリガーする条件付き書式ルールを設定します                  |

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

### 条件付き書式ルールの取得

* `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` は移動タイプ（例: 'before'、'after'）を指定します。

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

// 3 番目のルールを 1 番目のルールの前に移動します
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/ja-JP/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>
  )
}
```