FoxitPDFSDKforWeb  7.1.1
Foxit PDF SDK for Web
PDFDocRender Class Reference

The class that controls PDF document rendering. More...

Inherits Render.

Public Member Functions

 getPDFDoc ()
 
 getScale ()
 Gets the current display multiple of the document. More...
 
 getUserPermission ()
 Gets permissions for the view's documents
It's the intersection of PDFDoc::getPermissions() and initialization parameter options.customs.getDocPermissions for the pdfviewer. More...
 
 getViewMode ()
 Gets the current view mode instance object. More...
 
 getWatermarkConfig ()
 Gets the document watermark information. More...
 
 goToPage (index,{x=0, y=0, width, height}={}, isPDFPoint=false)
 Jump to page. More...
 
 setWatermarkConfig (watermarkConfig)
 Sets the document watermark information. More...
 

Detailed Description

The class that controls PDF document rendering.

Member Function Documentation

◆ getPDFDoc()

PDFDocRender::getPDFDoc ( )
inline

Get the PDF document object

Returns
{PDFDoc}

◆ getScale()

PDFDocRender::getScale ( )
inline

Gets the current display multiple of the document.

Returns
{Promise.<number | string>} 'fitWidth' | 'fitHeight

◆ getUserPermission()

PDFDocRender::getUserPermission ( )
inline

Gets permissions for the view's documents
It's the intersection of PDFDoc::getPermissions() and initialization parameter options.customs.getDocPermissions for the pdfviewer.

Returns
{UserPermission}
function example (PDFViewer, UserPermission) {
var pdfViewer = new PDFViewer({
customs: {
getDocPermissions: function (pdfDoc) {
// All users have read-only access only
var userPermission = new UserPermission();
userPermission.putCannotModifyAny();
return (userPermission).getValue();
}
}
});
...
var pdfDocRender = pdfViewer.getPDFDocRender();
if (pdfDocRender) {
pdfDocRender.getUserPermission().then(function (docViewerPermission) {
})
}
}
Since
7.1.0

◆ getViewMode()

PDFDocRender::getViewMode ( )
inline

Gets the current view mode instance object.

Returns
{Object} view mode instance object

◆ getWatermarkConfig()

PDFDocRender::getWatermarkConfig ( )
inline

Gets the document watermark information.

Returns
{Object} Document watermarking configuration.

◆ goToPage()

PDFDocRender::goToPage (   index,
  {x=0, y=0, width, height} = {},
  isPDFPoint = false 
)
inline

Jump to page.

Parameters
index{number} - page index.
offset{object} - The offset in the upper left corner.
offset.x{number} - The X-axis offset in the upper-left corner of the page.
offset.y{number} - The Y-axis offset in the upper-left corner of the page.
isPDFPoint{boolean} - If true, offset is the PDF coordinate; otherwise, the device coordinate.

◆ setWatermarkConfig()

PDFDocRender::setWatermarkConfig (   watermarkConfig)
inline

Sets the document watermark information.

Parameters
watermarkConfig{Object} - Page watermarking configuration. * Example:
{
type:"text",
content:"This is a watermark",
watermarkSettings:{
position:"TopLeft",
offsetX:0,
offsetY:0,
scaleX:1,
scaleY:1,
rotation:45,
opacity:100
},
watermarkTextProperties:{
font:"Microsoft Yahei",
fontSize:20,
color:"#000000",
fontStyle:"normal",
lineSpace:10,
alignment:"center"
}
};
watermarkConfig.typeString - Specifies watermark's type. One of following values: 1."text" represents a text type watermark.
2."image" represents the image type watermark.
watermarkConfig.content{String} - Specifies watermark's type. One of following values: 1.text type:<String> Text type watermark string.
2.image type:<DataURL> Image of DataURL.
watermarkConfig.watermarkSettingsobject - Watermark related configuration.
watermarkConfig.watermarkSettings.positionString - Position of watermark. Default value is "Center". Available values are listed below.
1."TopLeft":Position: top left.
2."TopCenter":Position: top center.
3."TopRight":Position: top right.
4."CenterLeft":Position center left.
5."Center":Position: center.
6."CenterRight":Position: center right.
7."BottomLeft":Position: bottom left.
8."BottomCenter":Position: bottom center.
9."BottomRight":Position: bottom right.
watermarkConfig.watermarkSettings.offsetXNumber - Horizontal offset.The default value is 0.
watermarkConfig.watermarkSettings.offsetYNumber - Vertical offset.The default value is 0.
watermarkConfig.watermarkSettings.scaleXNumber - Horizontal scale coefficient.The default value is 1.
watermarkConfig.watermarkSettings.scaleYNumber - Vertical scale coefficient.The default value is 1.
watermarkConfig.watermarkSettings.rotationNumber - Rotation angle in degrees.The default value is 45.
watermarkConfig.watermarkSettings.opacityNumber - Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.The default value is 100.
watermarkConfig.watermarkTextPropertiesobject - Unique configuration for text watermarking.
watermarkConfig.watermarkTextProperties.fontString - Font Name.The default value is "Microsoft Yahei".
watermarkConfig.watermarkTextProperties.fontSizeNumber - Font size.The default value is 20.
watermarkConfig.watermarkTextProperties.colorString - Font color.The default value is "#000000".
watermarkConfig.watermarkTextProperties.fontStyleString - The default value is "normal". Available values are listed below.
1."normal":Watermark font style: normal.
2."underline":Watermark font style: with underline.
watermarkConfig.watermarkTextProperties.lineSpaceNumber - Line spacing.The default value is 10.
watermarkConfig.watermarkTextProperties.alignmentString - Alignment. The default value is "center". Available values are listed below.
1."left":Left alignment.
2."center":Center alignment.
3."right":Right alignment.

Foxit Software Corporation Logo
@2019 Foxit Software Incorporated. All rights reserved.