Crosshair Highlight
| Packages | @univerjs/sheets-crosshair-highlight |
|---|
Facade APIs and event names for the Sheets crosshair highlight plugin.
Import
@univerjs/sheets-crosshair-highlight/facadebefore 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): FUniverExamples
TypeScript
univerAPI.setCrosshairHighlightEnabled(true)univerAPI.setCrosshairHighlightEnabled(false)@univerjs/sheets-crosshair-highlight
getCrosshairHighlightEnabled
Signature
TypeScript
getCrosshairHighlightEnabled(): boolean@univerjs/sheets-crosshair-highlight
CrosshairHighlightEnabledChanged
Signature
TypeScript
univerAPI.addEvent(univerAPI.Event.CrosshairHighlightEnabledChanged, (params) => { const { enabled } = params})Event Parameters
enabledboolean- The current enabled state.
@univerjs/sheets-crosshair-highlightHow is this guide?