An overlay is a static image that can be imposed onto a document when it is viewed. See the System Administration module reference guide for more information on configuring and using overlays. The way that the front-end client displays overlays is controlled by the overlayMode key in the docHitList object. This setting can override the default overlay mode set by the API. Set the overlayMode key to one of the following values to specify the overlay mode:
Overlays are only displayed if the front-end client is using the PDF viewer mode.
|
Value |
Description |
|---|---|
|
Off |
Overlays are not displayed on documents. |
|
|
Overlays are displayed on documents in a printer-friendly format. |
|
View |
Overlays are displayed on documents as configured. |
|
null |
The default overlay mode set by the API is used. |
For example, to display document overlays as they are configured, set the overlayMode key as follows:
"overlayMode": "View"