[e2pdf-view]

Shortcode is applied to insert PDF to the page via pdf.js viewer.

Basic Attributes #

  • Default shortcode can be used inside elements that support the "auto" dataset.
    • id - The ID of the E2pdf Template to use.
  • Shortcode to output PDF download link for the "static" PDF from the server.
    • pdf - Full path to static PDF or PDF URL.
    • dataset - The ID of the "dataset" to use for which it must be generated PDF. A dynamic dataset will be used if not set, depending on where the shortcode is placed.

      It's required to be set if shortcode placed at:
      • PHP functions
      • Elements that do not support "auto" dataset
    • dataset2 - The ID of the 2nd "dataset" to use for which it must be generated PDF.

      Can be used with:
      • Extension: Formidable Forms, Item: Merged Items
    • user_id - Overwrite defined User ID for [e2pdf-user] shortcode.
    • arg1, arg2, arg3, ... - Add custom values to be accessible inside PDF.

      • Usage inside E2Pdf Template:
    • output - Output of the shortcode.
      • url - Output PDF download link.

    • esc_url_raw - Output Encoded / Non encoded PDF download link.

Style Attributes #

    • class - Additional classes to add to generated pdf.js viewer.
    • page - Set scroll to a page on pdf.js viewer load.
    • zoom - Set zoom on pdf.js viewer load.
      • (int)
      • page-width
      • page-height
      • page-fit
      • auto
    • nameddest - Go to a named destination on pdf.js viewer load.
    • pagemode - Sidebar state on on pdf.js viewer load.
      • none
      • thumbs
      • bookmarks
      • attachments
    • responsive - Set pdf.js viewer to dynamic height.
      • true - Fit pdf.js viewer to full PDF size
      • page - Fit pdf.js viewer to first page PDF size
    • background - Set pdf.js viewer background color.
    • border - Set pdf.js viewer border.
    • hide - Hide elements from pdf.js viewer.
      • toolbar
      • secondary-toolbar
      • left-toolbar
      • middle-toolbar
      • right-toolbar
      • sidebar
      • search
      • pageupdown
      • pagenumber
      • zoom
      • scale
      • presentation
      • openfile
      • openfile
      • print
      • download
      • bookmark
      • firstlastpage
      • rotate
      • cursor
      • scroll
      • spread
      • properties

PDF Settings Attributes #

    • name - Overwrite the "PDF Name" option setting inside E2Pdf Template.
    • password - Overwrite the "PDF Password" option setting inside E2Pdf Template.
    • format - Overwrite the "Format" option setting inside E2Pdf Template.

      • pdf
      • jpg
    • flatten - Overwrite the "Flatten" (read-only) option setting inside E2Pdf Template.

      • 0 - No flatten (editable fields)
      • 1 - Flatten (readonly fields)
      • 2 - Full flatten (PDF pages as images)
    • inline - Overwrite the "Inline" option setting inside E2Pdf Template.