Interface: StampAnnotations
Groups all the API actions related to the stamp annotations.
Properties
addEventListener()
addEventListener: (
eventName,callback) =>void
Parameters
• eventName: "toggled" | "predefinedTextStampTypeSelected"
• callback: (active) => void | (stampType) => void
Returns
void
emitPredefinedTextStampTypeSelected()
emitPredefinedTextStampTypeSelected: (
stampType) =>void
Triggers an event indicating that a stamp type has been selected.
Parameters
• stampType: PredefinedTextStampType
The PredefinedTextStampType value that was selected.
Returns
void
emitToggled()
emitToggled: (
active) =>void
Triggers an event indicating that the stamp annotations panel has been toggled (opened or closed).
Parameters
• active: boolean
true if the stamp annotations panel has been opened, false otherwise.
Returns
void
Example
PdfToolsViewerApi.stampAnnotations.emitToggled(true);
removeEventListener()
removeEventListener: (
eventName,callback) =>void
Parameters
• eventName: "toggled" | "predefinedTextStampTypeSelected"
• callback: (active) => void | (stampType) => void
Returns
void