Class

BoxOverlay

BoxOverlay()

Constructor

# new BoxOverlay()

View Source BoxOverlay.ts, line 8

Example
```
const boxOverlay = new BoxOverlay()

boxOverlay.on('updateRect', (rect) => {
  console.log('Update rect', rect)
})

boxOverlay.add(ELEMENT_TO_BE_HIGHLIGHTED)
boxOverlay.start()

setTimeout(() => {
  boxOverlay.stop()
}, 5000)
```

Members

# readonly overlay

Properties:
Name Type Description
overlay Overlay

View Source BoxOverlay.ts, line 32

# readonly overlay

Properties:
Name Type Description
overlay Overlay

View Source BoxOverlay.ts, line 153

Methods

# add(selectorOrElement)

Parameters:
Name Type Description
selectorOrElement Element | string

View Source BoxOverlay.ts, line 42

Events

Rect | null

# updateRect

Called when the position or size of the highlight area has changed

View Source BoxOverlay.ts, line 102