ViewOptions Leave feedback
ViewOptions data structure used as input parameters for Document Info working-with-viewer-api API and Document View working-with-viewer-api API.
NoteNot all options are supported by all document formats. Each option may correspond to one or more formats.
{
"ViewFormat": "HTML",
"FileInfo": {
"FilePath": "string",
"StorageName": "string",
"VersionId": "string",
"Password": "string"
},
"OutputPath": "string",
"FontsPath": "string",
"Watermark": {
"Text": "string",
"Color": "string",
"Position": "string",
"Size": 0
},
"RenderOptions": {
"StartPageNumber": 0,
"CountPagesToRender": 0,
"ExternalResources": false,
"ExtractText": false,
}
}
| Name | Description | API Version |
|---|---|---|
| ViewFormat | Allows to set rendering format, available values are: HTML, JPG, PNG, PDF. Default value is “HTML”. | |
| FileInfo.FilePath | The path of the document, located in the storage. Required. | |
| FileInfo.StorageName | Storage name | |
| FileInfo.VersionId | File version Id | |
| FileInfo.Password | Password for rendering password-protected documents | |
| OutputPath | The output path for results. Default value is ‘viewer{input file path}_{file extension}' | v19.4 |
| FontsPath | Path of the folder, containing fonts, used for documents rendering. | |
| Watermark.Text | The watermark text. | |
| Watermark.Color | The watermark color. Supported formats “Magenta”, “(112,222,11)”, “(50,112,222,11)”. Default value is “Red”. | |
| Watermark.Position | The watermark position. Supported positions “Diagonal”, “TopLeft”, “TopCenter”, “TopRight”, “BottomLeft”, “BottomCenter” and “BottomRight”. Default value is “Diagonal”. | |
| Watermark.Size | Watermark size in percents. Default value is 100. | |
| RenderOptions | RenderOptionsin case of ViewFormat # PDF, HtmlOptions in case of ViewFormat # HTML, ImageOptionsin case of ViewFormat # PNG or JPG |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
