Class IIOverlayManager

Unified overlay manager for all symbol types.

Responsibilities:

Math blocks: ∑ badge, border, hover zone, highlights, dimming
Text blocks: recognized text badge, border

Owned by InteractiveInkCanvas as canvas.overlays.

Hierarchy (View Summary)

IIAbstractManager
- IIOverlayManager

Constructors

constructor

new IIOverlayManager(
canvas: TInteractiveInkCanvas,
config?: Partial<TOverlayConfig>,
): IIOverlayManager
Parameters
- canvas: TInteractiveInkCanvas
- config: Partial<TOverlayConfig> = {}
Returns IIOverlayManager
Overrides IIAbstractManager.constructor
- Defined in manager/interactive/IIOverlayManager.ts:104

Properties

`Protected`canvas

canvas: TInteractiveInkCanvas

The Interactive Ink Canvas instance

`Protected`logger

logger: Logger

Logger instance for this manager Automatically uses LoggerCategory.MANAGER

`Protected`managerName

managerName: string = "IIOverlayManager"

Name of the manager for logging purposes Must be overridden in concrete classes

Example

"IITypesetManager", "IIMathManager"

Accessors

client

get client(): WebSocketClient
Get the client from the canvas Convenience getter to avoid accessing canvas.client everywhere

Returns WebSocketClient
Inherited from IIAbstractManager.client
- Defined in manager/interactive/IIAbstractManager.ts:98

configuration

get configuration(): InteractiveInkCanvasConfiguration
Get the configuration from the canvas Convenience getter to avoid accessing canvas.configuration everywhere

Returns InteractiveInkCanvasConfiguration
Inherited from IIAbstractManager.configuration
- Defined in manager/interactive/IIAbstractManager.ts:106

model

get model(): IIModel
Get the model from the canvas Convenience getter to avoid accessing canvas.model everywhere

Returns IIModel
Inherited from IIAbstractManager.model
- Defined in manager/interactive/IIAbstractManager.ts:82

renderer

get renderer(): SVGRenderer
Get the renderer from the canvas Convenience getter to avoid accessing canvas.renderer everywhere

Returns SVGRenderer
Inherited from IIAbstractManager.renderer
- Defined in manager/interactive/IIAbstractManager.ts:90

Methods

addHoverGlow

addHoverGlow(id: string, bounds: TBox): void
Parameters
- id: string
- bounds: TBox
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:474

apply

apply(): void
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:577

clearAll

clearAll(): void
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:395

clearDimming

clearDimming(): void
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:571

clearHighlights

clearHighlights(): void
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:492

`Protected`createHoverZone

createHoverZone(bounds: TBox, blockId: string): void
Parameters
- bounds: TBox
- blockId: string
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:271

destroy

destroy(): void
Destroy the manager and cleanup resources Calls the onDestroy hook if defined

Returns void
Inherited from IIAbstractManager.destroy
- Defined in manager/interactive/IIAbstractManager.ts:146

dimSymbol

dimSymbol(id: string, bounds: TBox, opacity?: number): void
Parameters
- id: string
- bounds: TBox
- opacity: number = 0.3
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:484

`Protected`drawBadge

drawBadge(box: TBox, id: string, content: string): void
Parameters
- box: TBox
- id: string
- content: string
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:123

`Protected`drawBorder

drawBorder(box: TBox, id: string, color?: string, dashArray?: string): void
Parameters
- box: TBox
- id: string
- color: string = "#cccccc"
- OptionaldashArray: string
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:171

`Protected`drawLabel

drawLabel(box: TBox, id: string, fullLabel: string): void
Parameters
- box: TBox
- id: string
- fullLabel: string
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:192

`Protected`drawOverlayRect

drawOverlayRect(
    id: string,
    bounds: TBox,
    idPrefix: string,
    attrs: Partial<Record<string, string>>,
): void
Parameters
- id: string
- bounds: TBox
- idPrefix: string
- attrs: Partial<Record<string, string>>
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:429

getConfig

getConfig(): TOverlayConfig
Returns TOverlayConfig
- Defined in manager/interactive/IIOverlayManager.ts:119

hideVariableEncart

hideVariableEncart(): void
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:567

highlightLinked

highlightLinked(id: string, bounds: TBox): void
Parameters
- id: string
- bounds: TBox
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:455

highlightPrimary

highlightPrimary(id: string, bounds: TBox, color?: string): void
Parameters
- id: string
- bounds: TBox
- Optionalcolor: string
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:446

highlightWithColor

highlightWithColor(box: TBox, symbolId: string, colorKey: string): void
Parameters
- box: TBox
- symbolId: string
- colorKey: string
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:464

`Protected` `Optional`onDestroy

onDestroy?(): void
Lifecycle hook called when the manager is being destroyed Override in subclasses to cleanup resources

Returns void
Example
```
protected onDestroy(): void {
  this.logger.info(`${this.managerName} destroyed`)
  // Remove event listeners, clear intervals, etc.
}
```
Inherited from IIAbstractManager.onDestroy
- Defined in manager/interactive/IIAbstractManager.ts:140

`Protected` `Optional`onInit

onInit?(): void
Lifecycle hook called after manager initialization Override in subclasses if needed

This is called at the end of the constructor, allowing subclasses to perform initialization that requires access to this.managerName or other properties set in the subclass constructor.

Returns void
Example
```
protected onInit(): void {
  this.logger.info(`${this.managerName} initialized`)
  // Setup event listeners, etc.
}
```
Inherited from IIAbstractManager.onInit
- Defined in manager/interactive/IIAbstractManager.ts:126

refresh

refresh(): void
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:313

`Protected`refreshEdgeNodeOverlays

refreshEdgeNodeOverlays(): void
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:371

`Protected`refreshMathOverlays

refreshMathOverlays(): void
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:343

`Protected`refreshTextOverlays

refreshTextOverlays(): void
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:357

`Protected`sanitizeId

sanitizeId(id: string): string
Parameters
- id: string
Returns string
- Defined in manager/interactive/IIOverlayManager.ts:425

showVariableEncart

showVariableEncart(
options: { anchor: TPoint; items: TVariableEncartItem[] },
): void
Small box, centered on anchor, listing non-BLOCK-sourced variables (API/Global/Predefined/Undefined) used by the hovered or selected math block. Each row's swatch matches the color of that variable's highlighted occurrence(s) in the block ink (see highlightWithColor).
Parameters
- options: { anchor: TPoint; items: TVariableEncartItem[] }
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:507

updateConfig

updateConfig(config: Partial<TOverlayConfig>): void
Parameters
- config: Partial<TOverlayConfig>
Returns void
- Defined in manager/interactive/IIOverlayManager.ts:113

Class IIOverlayManager

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns IIOverlayManager

Properties

Protectedcanvas

Protectedlogger

ProtectedmanagerName

Example

Accessors

client

Returns WebSocketClient

configuration

Returns InteractiveInkCanvasConfiguration

model

Returns IIModel

renderer

Returns SVGRenderer

Methods

addHoverGlow

Parameters

Returns void

apply

Returns void

clearAll

Returns void

clearDimming

Returns void

clearHighlights

Returns void

ProtectedcreateHoverZone

Parameters

Returns void

destroy

Returns void

dimSymbol

Parameters

Returns void

ProtecteddrawBadge

Parameters

Returns void

ProtecteddrawBorder

Parameters

Returns void

ProtecteddrawLabel

Parameters

Returns void

ProtecteddrawOverlayRect

Parameters

Returns void

getConfig

Returns TOverlayConfig

hideVariableEncart

Returns void

highlightLinked

Parameters

Returns void

highlightPrimary

Parameters

Returns void

highlightWithColor

Parameters

Returns void

Protected OptionalonDestroy

Returns void

Example

Protected OptionalonInit

Returns void

Example

refresh

Returns void

ProtectedrefreshEdgeNodeOverlays

Returns void

`Protected`canvas

`Protected`logger

`Protected`managerName

`Protected`createHoverZone

`Protected`drawBadge

`Protected`drawBorder

`Protected`drawLabel

`Protected`drawOverlayRect

`Protected` `Optional`onDestroy

`Protected` `Optional`onInit

`Protected`refreshEdgeNodeOverlays

`Protected`refreshMathOverlays

`Protected`refreshTextOverlays

`Protected`sanitizeId