Interface: ToolbarButtonInterface
Interface for toolbar buttons.
Extends
EventHandlerInterface<"clicked",EventMap["PdfTools.toolbar.button.clicked"]>
Properties
addEventListener()
addEventListener: (
eventName,callback) =>void
Adds an event listener for specified events.
Parameters
• eventName: "clicked"
• callback
Returns
void
Inherited from
EventHandlerInterface.addEventListener
emitClicked()
emitClicked: (
componentName,payload?) =>void
Triggered when a toolbar button is clicked.
Parameters
• componentName: string
The name of the component (button) clicked.
• payload?: unknown
Optional payload with additional information the component needs.
Returns
void
Example
viewer.toolbar.button.emitClicked('icon-button-print')
hasEventListener()
hasEventListener: (
eventName) =>boolean
Checks if an event listener is already attached to a toolbar button click event.
Parameters
• eventName: "clicked"
The event name to check (e.g., 'clicked').
Returns
boolean
true if the event listener is attached, otherwise false.
Example
const hasEvent = viewer.toolbar.button.hasEventListener('clicked');
removeEventListener()
removeEventListener: (
eventName,callback) =>void
Removes an event listener for specified events.
Parameters
• eventName: "clicked"
• callback
Returns
void
Inherited from
EventHandlerInterface.removeEventListener