• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Use case developmentWorkshopVisualization widgetsPDF Viewer

    PDF Viewer

    The PDF Viewer widget supports keyword search capabilities with text highlighting and auto-scroll on match, thus enhancing PDF workflows via manual or variable-based inputs.

    PDF Viewer

    The capability provides many enhanced functionalities including, but not limited to, the following:

    • Accepting string variables for keyword matches throughout the document.
    • Built-in search functionality for keyword matches provided by user.
    • Match highlighting (green for current match; purple for others) and hit count display.
    • Snaps to first result and between other hits.
    • Supports MediaReferences (media sets).

    Configuration options

    The widget configuration supports several media input sources along with variable inputs for page numbers and text. The variable page number input will navigate users to the specified page within the PDF. The configured text input will be populated into the search bar, and a keyword search will be executed against that term. Even without configuring the widget, you can still manually enter any search term in the PDF view.

    Choose a media source from the top of the configuration page to add a PDF to the widget. The configuration panel for a newly created PDF Viewer widget.

    • Configure PDF sourcing options:

      • Select the desired media source to populate the widget with a PDF. The dropdown will provide a list of supported media sources media sources available to you. Currently suported media sources are Compass, datasets, media references, and attachments. Once the media source is selected, configuration for that media source will be available. Example media sources may include:
        • Compass: Uses the Palantir file system as a media source for PDFs. When selecting this option, provide the following:
          • Blobster RID: A string variable to specify the Blobster RID for the desired PDF.
        • Dataset: Uses a dataset as a media source for PDFs. When selecting this option, provide the following:
          • Dataset RID: A string variables to specify the RID of the dataset that contains the desired PDF.
          • File Path: A string variable to specify the file path within the dataset of the desired PDF.
          • Branch: A string variable to specify the branchID for the dataset. If no branch is specified, this will default to the master branch.
        • Media reference: Define an object set with a single object and select the media reference typed property for the PDF.
          • Object set with a single object: An object set variable for the desired PDF. The object set selected must contain a single object.
          • Property: The desired media reference typed property from the selected object set for the desired PDF.
        • Attachments: Define an object set with a single object and selete the attachment property as a media source for PDFs. When selecting this option, provide the following:
          • Object set with a single object: An object set variable for the desired PDF. The object set selected must contain a single object.
          • Property: The desired attachment property from the selected object set for the desired PDF.

    • Configure input variables:

      • Page Number: Add a numeric variable to navigate users to the specified page number within the PDF. This will be the page displayed to users when accessing the widget. If no variable is provided, the first page of the PDF will be displayed.
      • Search for Text: Add a string variable to prepopulate the keyword used to search within the widget.
      • Enable PDF Downloads: Allows users to download the PDF displayed in the widget.