Class: exports.ViewerOverlayBase

OSDPaperjsAnnotation.exports.ViewerOverlayBase(viewer, optsopt)

Base class for viewer overlay types (screenshot, fieldofview, rotation, etc.). Extends OpenSeadragon.EventSource to provide event handling (addHandler/removeHandler/raiseEvent). Provides the shared activate/deactivate lifecycle via _setActive(), which fires 'active-change'. Subclasses should override activate() and deactivate(), call _setActive(true/false) within them, and provide static label and faIconClass getters.

Constructor

new exports.ViewerOverlayBase(viewer, optsopt)

Parameters:
Name Type Attributes Description
viewer OpenSeadragon.Viewer
opts Object <optional>
Properties
Name Type Attributes Default Description
registerWithConfig boolean <optional>
 true Set false to suppress auto-registration with ConfigurationWidget
showButton boolean <optional>
 true Set false to hide the toolbar button initially (manageable via ConfigurationWidget toggle)
Source:

Extends

  • OpenSeadragon.EventSource