# 十字高亮

- Human documentation: [https://docs.univer.ai/zh-CN/guides/sheets/features/crosshair-highlighting](https://docs.univer.ai/zh-CN/guides/sheets/features/crosshair-highlighting)

- Agent Markdown: [https://docs.univer.ai/zh-CN/guides/sheets/features/crosshair-highlighting.md](https://docs.univer.ai/zh-CN/guides/sheets/features/crosshair-highlighting.md)

- Requested language: `zh-CN`

- Content language: `zh-CN`

- Documentation version: `1.0.0-rc.0`

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

---

#### Package metadata

```json
{
  "plugins": [
    {
      "client": "@univerjs/sheets-crosshair-highlight",
      "facade": "@univerjs/sheets-crosshair-highlight/facade",
      "locale": "@univerjs/sheets-crosshair-highlight/locale/zh-CN",
      "style": "@univerjs/sheets-crosshair-highlight/lib/index.css"
    }
  ],
  "server": false
}
```

十字高亮将用户选中的单元格所在行列突出显示，以便用户更容易地识别当前选中的单元格。

> Interactive example: [Open the playground](/playground/sheets/crosshair-highlighting)

## 预设模式

十字高亮并未提供预设模式，但支持与其插件混用。

#### npm

```bash
npm install @univerjs/sheets-crosshair-highlight
```

#### pnpm

```bash
pnpm add @univerjs/sheets-crosshair-highlight
```

#### yarn

```bash
yarn add @univerjs/sheets-crosshair-highlight
```

#### bun

```bash
bun add @univerjs/sheets-crosshair-highlight
```

### 使用

```typescript
import UniverPresetSheetsCoreZhCN from '@univerjs/preset-sheets-core/locales/zh-CN'
import { UniverSheetsCrosshairHighlightPlugin } from '@univerjs/sheets-crosshair-highlight' // [!code ++]

import '@univerjs/sheets-crosshair-highlight/facade' // [!code ++]

import '@univerjs/sheets-crosshair-highlight/lib/index.css' // [!code ++]

const { univerAPI } = createUniver({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: mergeLocales(
      UniverPresetSheetsCoreZhCN,
      SheetsCrosshairHighlightZhCN, // [!code ++]
    ),
  },
  presets: [
    UniverSheetsCorePreset(),
  ],
  plugins: [
    UniverSheetsCrosshairHighlightPlugin, // [!code ++]
  ],
})
```

## 插件模式

### 安装

#### npm

```bash
npm install @univerjs/sheets-crosshair-highlight
```

#### pnpm

```bash
pnpm add @univerjs/sheets-crosshair-highlight
```

#### yarn

```bash
yarn add @univerjs/sheets-crosshair-highlight
```

#### bun

```bash
bun add @univerjs/sheets-crosshair-highlight
```

### 使用

```typescript
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import { UniverSheetsCrosshairHighlightPlugin } from '@univerjs/sheets-crosshair-highlight'
import SheetsCrosshairHighlightZhCN from '@univerjs/sheets-crosshair-highlight/locale/zh-CN'

import '@univerjs/sheets-crosshair-highlight/lib/index.css'

import '@univerjs/sheets-crosshair-highlight/facade'

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

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

## Facade API

完整 Facade API 类型定义，请查看 [FacadeAPI](https://reference.univer.ai/zh-CN)。

### 引入

> [!INFO: 插件模式提示]
> 仅插件模式需要手动引入 Facade 包。预设模式已内置对应的 Facade 包，无需额外导入。

```typescript
import '@univerjs/sheets-crosshair-highlight/facade'
```

### 切换十字高亮开关

```typescript
univerAPI.setCrosshairHighlightEnabled(true)

univerAPI.setCrosshairHighlightEnabled(false)
```

### 获取十字高亮开关状态

```typescript
univerAPI.getCrosshairHighlightEnabled()
```

### 事件监听

完整事件类型定义，请查看 [Events](https://docs.univer.ai/zh-CN/reference/facade/events.md)。

`CrosshairHighlightEnabledChanged` 事件将在十字高亮开关状态发生变化时触发。

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

// 移除事件监听器，使用 `disposable.dispose()`
```

`CrosshairHighlightColorChanged` 事件将在十字高亮颜色发生变化时触发。

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

// 移除事件监听器，使用 `disposable.dispose()`
```