Link

Microservice Settings

The FormVu Microservice has a number of settings that can be applied to grant better control of your conversion. These settings are detailed below.

Available Settings

  1. org.jpedal.pdf2html.addJavaScript
  2. org.jpedal.pdf2html.compressImages
  3. org.jpedal.pdf2html.compressSVG
  4. org.jpedal.pdf2html.containerId
  5. org.jpedal.pdf2html.convertPDFExternalFileToOutputType
  6. org.jpedal.pdf2html.convertSpacesToNbsp
  7. org.jpedal.pdf2html.disableComments
  8. org.jpedal.pdf2html.disableLinkGeneration
  9. org.jpedal.pdf2html.embedImagesAsBase64Stream
  10. org.jpedal.pdf2html.enableAcroFormJS
  11. org.jpedal.pdf2html.fontsToRasterizeInTextMode
  12. org.jpedal.pdf2html.formTag
  13. org.jpedal.pdf2html.generateSearchFile
  14. org.jpedal.pdf2html.imageScale
  15. org.jpedal.pdf2html.includedFonts
  16. org.jpedal.pdf2html.inlineJavaScriptAndCSS
  17. org.jpedal.pdf2html.inlineSVG
  18. org.jpedal.pdf2html.keepGlyfsSeparate
  19. org.jpedal.pdf2html.logicalPageRange
  20. org.jpedal.pdf2html.noCheckboxOrRadioButtonImages
  21. org.jpedal.pdf2html.outputContentMode
  22. org.jpedal.pdf2html.outputThumbnails
  23. org.jpedal.pdf2html.password
  24. org.jpedal.pdf2html.realPageRange
  25. org.jpedal.pdf2html.scaling
  26. org.jpedal.pdf2html.separateTextToWords
  27. org.jpedal.pdf2html.submitUrl
  28. org.jpedal.pdf2html.textMode
  29. org.jpedal.pdf2html.useDRFormFonts
  30. org.jpedal.pdf2html.useFormVuAPI
  31. org.jpedal.pdf2html.useLegacyImageFileType

org.jpedal.pdf2html.addJavaScript

Include all the JavaScript that is within the PDF file.

Required? No

Accepted Values

  • true
  • false

Default false

org.jpedal.pdf2html.compressImages

Compress PNG images to reduce file size

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.compressSVG

Generates compressed .svgz files rather than .svg

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.containerId

Set the id to use for the page container div

Required? No

Accepted Values

  • Any string

Default jpedal


org.jpedal.pdf2html.convertPDFExternalFileToOutputType

Set whether to convert links pointing to file.pdf into file.html inside GoToR and Launch link annotations.

Required? No

Accepted Values

  • true
  • false

Default true


org.jpedal.pdf2html.convertSpacesToNbsp

Convert spaces into Non-breaking Spaces ( ) in the output

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.disableComments

Disable comments inserted into the HTML output for clarity

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.disableLinkGeneration

Disables the generation of clickable links (when present in the PDF) and outputs as plain text instead.

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.embedImagesAsBase64Stream

Insert the images directly into the file as a base64 stream instead of referencing an external file

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.enableAcroFormJS

Enable JavaScript from the AcroForms to be included in the conversion output. JavaScript functionality must already be present in the PDF.

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.fontsToRasterizeInTextMode

In svg_realtext this flag will have the specified fonts appear as part of SVG as Vectors. This setting has no effect on other modes,

Required? No

Accepted Values

  • INCLUDE=font1,font2,font3
  • EXCLUDE=font1,font2,font3

Note: INCLUDE will only rasterize the listed fonts, EXCLUDE will rasterize all fonts except those in the list.

Default null


org.jpedal.pdf2html.formTag

Replacing <form> with your version.

Required? No

Accepted Values

  • <form **your code here**>

Default <form>


org.jpedal.pdf2html.generateSearchFile

Generates a search.json file containing the text of the document you can process for different uses such as search.

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.imageScale

Write out larger images to allow higher quality zooming. Value is a float from 0.1 to 10 where 1 is 100%.

Required? No

Possible Values

Any float value from 0.1 to 10

Default 1


org.jpedal.pdf2html.includedFonts

Set font type to convert to and include in HTML and CSS output.

Required? No

Accepted Values

  • woff
  • otf
  • woff_base64
  • otf_base64

Default woff


org.jpedal.pdf2html.inlineJavaScriptAndCSS

Inline JavaScript and CSS within HTML. This inlines the JavaScript into <\script> tags and CSS into <\style> within HTML so that there are no separate .js/.css files.

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.inlineSVG

Inline SVG within HTML (pure SVG text modes only).

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.keepGlyfsSeparate

Position each glyph individually for more accurate text positioning

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.logicalPageRange

Set a page range to convert using logical page numbering.

Required? No

Possible Values

A string of comma separated values including ranges

e.g. “1,3,5-8,10”

Default null


org.jpedal.pdf2html.noCheckboxOrRadioButtonImages

Form elements inside PDFs can contain an AP dictionary with instructions for how to display the various states:

  • hover
  • onclick
  • checked
  • unchecked

By default, these appearances are written as images.

This setting disables these images for checkboxes and radio buttons. Instead, the standard browser appearances for the <input> implementations are used.

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.outputContentMode

The output content mode affects what content is included in the generated output. This can be used to reduce unwanted content.

Required? No

Accepted Values

  • DEFAULT - No changes to the output
  • NO_FDFXFADUMP - Disable the FDFXFA_DUMP div from the output
  • NO_MENU - Disable the FDFXFA_MENU div from the output
  • REDUCED_CONTENT - Disable both FDFXFA_DUMP, FDFXFA_MENU from the output

Important: When using NO_FDFXFADUMP or REDUCED_CONTENT you will lose the functionality of submitting data and saving data back to a PDF for acroform PDFs. If you intend to use these features do not use these modes.

NO_MENU can be beneficial for users who do not want to use the provided menu for any converted form files.

Default DEFAULT


org.jpedal.pdf2html.outputThumbnails

Output thumbnails of pages in /thumbnails/.

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.password

Set a password to be used when opening files

Required? No

Accepted Values A String

Default null


org.jpedal.pdf2html.realPageRange

Set a page range to convert using real page numbering. Value is a string of comma separated values including ranges.

Required? No

Possible Values A string of comma separated values including ranges

e.g. “1,3,5-8,10”

Default null


org.jpedal.pdf2html.scaling

Sets the Scaling value of the converted content. There are four types of value,a float multiplier (e.g. 1)best fit of width(e.g. fitWidth1000)height(e.g. fitHeight1000)or both(e.g. 1000x1000)

Required? No

Possible Values

  • a float multiplier (e.g. 1)
  • best fit for width (e.g. fitWidth1000)
  • best fit for height (e.g. fitHeight1000)
  • best fit for width and height (e.g. 1000x1000)

Default 1


org.jpedal.pdf2html.separateTextToWords

Improve text position accuracy by dividing text chunks into words based on spaces

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.submitUrl

Set the default pdf form submission URL. Used for the “Submit Form” button in the converted output

Required? No

Accepted Values

  • Any string

Default null


org.jpedal.pdf2html.textMode

Text mode controls how text is rendered in the html output

Required? No

Accepted Values

  • svg_realtext
  • svg_shapetext_selectable
  • svg_shapetext_nonselectable
  • image_realtext
  • image_shapetext_selectable
  • image_shapetext_nonselectable

Default svg_realtext


org.jpedal.pdf2html.useDRFormFonts

Be warned, this setting is experimental and is expected to be changed throughout versions

Allows control over whether embedded form fonts in DR object are used for display in text field

Required? No

Accepted Values

  • true
  • false

Default false


org.jpedal.pdf2html.useFormVuAPI

Output the formvuapi.js file, which handles custom functionality such as submitting forms as JSON

Required? No

Accepted Values

  • true
  • false

Default true


org.jpedal.pdf2html.useLegacyImageFileType

Output all images as PNGs

Required? No

Accepted Values

  • true
  • false

Default false

Still need help? Send us your questions.