# Crosshair Highlight

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

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

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

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

---

| Packages | `@univerjs/sheets-crosshair-highlight` |
| -------- | -------------------------------------- |

Facade APIs and event names for the Sheets crosshair highlight plugin.

> Import `@univerjs/sheets-crosshair-highlight/facade` before using these APIs in plugin mode.

## Overview

### @univerjs/sheets-crosshair-highlight

| API                                      | Signature                                                 | Description                                    |
| ---------------------------------------- | --------------------------------------------------------- | ---------------------------------------------- |
| `setCrosshairHighlightEnabled`           | `setCrosshairHighlightEnabled(enabled: boolean): FUniver` | Enable or disable crosshair highlighting.      |
| `getCrosshairHighlightEnabled`           | `getCrosshairHighlightEnabled(): boolean`                 | Get whether crosshair highlighting is enabled. |
| `Event.CrosshairHighlightEnabledChanged` | `CrosshairHighlightEnabledChanged`                        | Event fired after enabled state changes.       |

## APIs

### `setCrosshairHighlightEnabled`

**Signature**

```typescript
setCrosshairHighlightEnabled(enabled: boolean): FUniver
```

**Examples**

```ts
univerAPI.setCrosshairHighlightEnabled(true)
univerAPI.setCrosshairHighlightEnabled(false)
```

Source: 

`@univerjs/sheets-crosshair-highlight`

### `getCrosshairHighlightEnabled`

**Signature**

```typescript
getCrosshairHighlightEnabled(): boolean
```

Source: 

`@univerjs/sheets-crosshair-highlight`

### `CrosshairHighlightEnabledChanged`

**Signature**

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

**Event Parameters**

* `enabled` `boolean` - The current enabled state.

Source: 

`@univerjs/sheets-crosshair-highlight`