Type alias PdfHighlighterUtils

Type declaration

• clearSearch:function

  • clearSearch(): void

  • Clear active search highlights.

    Returns void

• findNext:function

  • findNext(): void

  • Move to the next search result.

    Returns void

• findPrevious:function

  • findPrevious(): void

  • Move to the previous search result.

    Returns void

• getCurrentSelection:function

  • getCurrentSelection(): null | PdfSelection

  • Get currently selected area or text selection.

    Returns null | PdfSelection

    • current selection or null if no selection is being made.

• getEventBus:function

  • getEventBus(): unknown

  • Get the event bus instance for page events.

    Returns unknown

    • The currently active event bus or null.

• getGhostHighlight:function

  • getGhostHighlight(): null | GhostHighlight

  • Get the currently present ghost highlight.

    Returns null | GhostHighlight

    • currently present ghost highlight or null if non-existent.

• getLinkService:function

  • getLinkService(): unknown

  • Get the PDF link service instance for navigation.

    Returns unknown

    • The currently active PDF link service or null.

• getTip:function

  • getTip(): null | Tip

  • Get the currently active tip, if any.

    Returns null | Tip

    • the currently active tip or null if inactive.

• getViewer:function

  • getViewer(): null | PDFViewer

  • Get a reference to the currently used instance of a PDF Viewer.

    Returns null | PDFViewer

    • The currently active PDF Viewer.

• goToPage:function

  • goToPage(pageNumber): void

  • Navigate to a specific page number.

    Parameters

    • pageNumber: number

      1-indexed page number to navigate to.

    Returns void

• isEditInProgress:function

  • isEditInProgress(): boolean

  • Whether an AreaHighlight is being moved/resized, or a manual highlight edit has been toggled.

    Returns boolean

    • true if AreaHighlight is being edited or edit mode was set.

• isEditingOrHighlighting:function

  • isEditingOrHighlighting(): boolean

  • Checks whether a selection is progress, a ghost highlight, or an edit.

    Returns boolean

    • true if editing, ghost highlighting, or selecting.

• isHighlightSelected:function

  • isHighlightSelected(): boolean

  • Whether any highlight is currently selected (toolbar showing).

    Returns boolean

• isSelectionInProgress:function

  • isSelectionInProgress(): boolean

  • Whether a mouse selection or text selection is currently being performed.

    Returns boolean

    • true if mouse selection or text selection is being performed.

• removeGhostHighlight:function

  • removeGhostHighlight(): void

  • Cancel any ghost highlight. The selected area will stay selected until the user clicks away.

    Returns void

• scrollToHighlight:function

  • scrollToHighlight(highlight): void

  • Scroll to a highlight in this viewer.

    Parameters

    • highlight: Highlight

      A highlight provided to the PdfHighlighter to scroll to.

    Returns void

• search:function

  • search(query, options?): void

  • Search for text in the PDF document.

    Parameters

    • query: string

      Search text.
    • Optional options: PdfSearchOptions

      Search options.

    Returns void

• setHighlightSelected:function

  • setHighlightSelected(selected): void

  • Marks a highlight as selected/deselected (its floating toolbar is open). Counter-backed, so overlapping select/deselect from different highlights resolves correctly. Used to suppress hover tips while a toolbar is shown.

    Parameters

    • selected: boolean

    Returns void

• setTip:function

  • setTip(tip): void

  • Set a tip to be displayed in the current PDF Viewer.

    Parameters

    • tip: null | Tip

      tip to be displayed, or null to hide any tip.

    Returns void

• toggleEditInProgress:function

  • toggleEditInProgress(flag?): void

  • If enabled, automatic tips/popups inside of a PdfHighlighter will be disabled. Additional niceties will also be provided to prevent new highlights being made.

    Parameters

    • Optional flag: boolean

    Returns void

• updateTipPosition:function

  • updateTipPosition(): void

  • Callback to update any currently active tip's position. This will make sure the tip is visible above/below its highlight.

    Returns void