Interface: Search
Groups all the API actions related to search functionality.
Properties
addEventListener()
addEventListener: (
eventName,fn) =>void
Adds an event listener to the different search events.
Parameters
• eventName: "toggled" | "searchResultClicked" | "settingsClicked" | "caseSensitiveToggled" | "regularExpressionToggled" | "clearSearchPanelInputClicked"
The event name (e.g., 'toggled', 'searchResultClicked', etc.).
• fn: (active) => void | (searchResult) => void | () => void | (caseSensitive) => void | (regularExpression) => void | () => void
The callback function to execute when the event is triggered.
Returns
void
Example
PdfToolsViewerApi.search.addEventListener('toggled', () => { console.log('callback') });
caseSensitiveToggled()
caseSensitiveToggled: (
caseSensitive) =>void
Triggers an event indicating that the search case-sensitive checkbox has been toggled.
Parameters
• caseSensitive: boolean
true if case sensitivity has been enabled, false otherwise.
Returns
void
Example
PdfToolsViewerApi.search.caseSensitiveToggled(false);
clearSearchPanelInputClicked()
clearSearchPanelInputClicked: () =>
void
Triggers an event indicating that the clear search panel input button has been clicked.
Returns
void
Example
PdfToolsViewerApi.search.clearSearchPanelInputClicked();
regularExpressionToggled()
regularExpressionToggled: (
regularExpression) =>void
Triggers an event indicating that the search regular expression checkbox has been toggled.
Parameters
• regularExpression: boolean
true if regular expressions have been enabled, false otherwise.
Returns
void
Example
PdfToolsViewerApi.search.regularExpressionToggled(true);
removeEventListener()
removeEventListener: (
eventName,fn) =>void
Removes an event listener attached to a search event.
Parameters
• eventName: "toggled" | "searchResultClicked" | "settingsClicked" | "caseSensitiveToggled" | "regularExpressionToggled" | "clearSearchPanelInputClicked"
The event name (e.g., 'toggled', 'searchResultClicked', etc.).
• fn: (active) => void | (searchResult) => void | () => void | (caseSensitive) => void | (regularExpression) => void | () => void
The callback function to remove from the event listener.
Returns
void
Example
PdfToolsViewerApi.search.removeEventListener('toggled', callback);
searchResultClicked()
searchResultClicked: (
sr) =>void
Triggers an event indicating that a search result has been clicked.
Parameters
• sr: any
The search result that was clicked.
Returns
void
Example
PdfToolsViewerApi.search.searchResultClicked(sr);
settingsClicked()
settingsClicked: () =>
void
Triggers an event indicating that the search settings have been clicked.
Returns
void
Example
PdfToolsViewerApi.search.settingsClicked();
toggled()
toggled: (
active) =>void
Triggers an event indicating that the search panel has been toggled (opened or closed).
Parameters
• active: boolean
true if the search panel has been opened, false otherwise.
Returns
void
Example
PdfToolsViewerApi.search.toggled(true);