Skip to main content
Version: Version 5 beta

Interface: Topbar

Groups all the API actions related to the topbar UI of the Viewer.

Properties

addEventListener()

addEventListener: (eventName, callback) => void

Parameters

eventName: "hideAll"

callback

Returns

void


emitHideAll()

emitHideAll: () => void

Returns

void


highlightTopbar

highlightTopbar: object

addEventListener()

addEventListener: (eventName, callback) => void

Parameters

eventName: "toggleVisibility"

callback

Returns

void

circleSelectColor

circleSelectColor: object

circleSelectColor.addEventListener()

addEventListener: (eventName, callback) => void

Parameters

eventName: "selected"

callback

Returns

void

circleSelectColor.emitSelected()

emitSelected: (selected, color) => void

Parameters

selected: boolean

color: `#${string}`

Returns

void

drawHighlighter

drawHighlighter: object

drawHighlighter.addEventListener()

addEventListener: (eventName, callback) => void

Parameters

eventName: "clicked"

callback

Returns

void

drawHighlighter.emitClicked()

emitClicked: () => void

Returns

void

emitToggleVisibility()

emitToggleVisibility: (visible?) => void

Parameters

visible?: boolean

Returns

void

textAnnotationSquigglet

textAnnotationSquigglet: object

textAnnotationSquigglet.addEventListener()

addEventListener: (eventName, callback) => void

Parameters

eventName: "clicked"

callback

Returns

void

textAnnotationSquigglet.emitClicked()

emitClicked: () => void

Returns

void

textAnnotationStrikeout

textAnnotationStrikeout: object

textAnnotationStrikeout.addEventListener()

addEventListener: (eventName, callback) => void

Parameters

eventName: "clicked"

callback

Returns

void

textAnnotationStrikeout.emitClicked()

emitClicked: () => void

Returns

void

textAnnotationUnderline

textAnnotationUnderline: object

textAnnotationUnderline.addEventListener()

addEventListener: (eventName, callback) => void

Parameters

eventName: "clicked"

callback

Returns

void

textAnnotationUnderline.emitClicked()

emitClicked: () => void

Returns

void


stickyNotesTopbar

stickyNotesTopbar: object

addEventListener()

addEventListener: (eventName, callback) => void

Parameters

eventName: "toggleVisibility"

callback

Returns

void

circleSelectColor

circleSelectColor: object

circleSelectColor.addEventListener()

addEventListener: (eventName, callback) => void

Parameters

eventName: "selected"

callback

Returns

void

circleSelectColor.emitSelected()

emitSelected: (selected, color) => void

Parameters

selected: boolean

color: `#${string}`

Returns

void

emitToggleVisibility()

emitToggleVisibility: (visible?) => void

Parameters

visible?: boolean

Returns

void