FoxitPDFSDKforWeb  7.1.1
Foxit PDF SDK for Web
PDFPageRender Class Reference

PDF page renderer. More...

Inherits Render.

Public Member Functions

 getAnnotRender (name)
 Gets annot render with specified name. More...
 
 getPDFDoc ()
 Get PDF doc. More...
 
 getPDFPage ()
 Get pdf page. More...
 
 getScale ()
 Get page scale. More...
 
 getWatermarkConfig ()
 Gets the page watermark information. More...
 
 reverseDeviceRect (deviceRect)
 Transform device rect to PDF rect. More...
 
 setWatermarkConfig (watermarkConfig)
 Sets the page watermark information. More...
 

Detailed Description

PDF page renderer.

Member Function Documentation

◆ getAnnotRender()

PDFPageRender::getAnnotRender (   name)
inline

Gets annot render with specified name.

Parameters
name{string} annotation name
Returns
{AnnotRender | null} Returns null when not found. If the page has not been rendered, null is returned

◆ getPDFDoc()

PDFPageRender::getPDFDoc ( )
inline

Get PDF doc.

Returns
{PDFDoc}

◆ getPDFPage()

PDFPageRender::getPDFPage ( )
inline

Get pdf page.

Returns
{Promise.<PDFPage>}

◆ getScale()

PDFPageRender::getScale ( )
inline

Get page scale.

Returns
{number}

◆ getWatermarkConfig()

PDFPageRender::getWatermarkConfig ( )
inline

Gets the page watermark information.

Returns
{Object} Page watermarking configuration.

◆ reverseDeviceRect()

PDFPageRender::reverseDeviceRect (   deviceRect)
inline

Transform device rect to PDF rect.

Parameters
deviceRect
Returns
{Promise.<PDFRect>}

◆ setWatermarkConfig()

PDFPageRender::setWatermarkConfig (   watermarkConfig)
inline

Sets the page 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"
}
};
@param watermarkConfig.type String - Specifies watermark's type. One of following values:
1."text" represents a text type watermark.\n
2."image" represents the image type watermark.\n
@param watermarkConfig.content {String} - Specifies watermark's type. One of following values:
1.text type:<String> Text type watermark string.\n
2.image type:<DataURL> Image of DataURL.\n
@param watermarkConfig.watermarkSettings object - Watermark related configuration. \n
@param watermarkConfig.watermarkSettings.position String - Position of watermark. Default value is "Center". Available values are listed below.\n
1."TopLeft":Position: top left. \n
2."TopCenter":Position: top center. \n
3."TopRight":Position: top right. \n
4."CenterLeft":Position center left. \n
5."Center":Position: center. \n
6."CenterRight":Position: center right. \n
7."BottomLeft":Position: bottom left. \n
8."BottomCenter":Position: bottom center. \n
9."BottomRight":Position: bottom right. \n
@param watermarkConfig.watermarkSettings.offsetX Number - Horizontal offset.The default value is 0.\n
@param watermarkConfig.watermarkSettings.offsetY Number - Vertical offset.The default value is 0.\n
@param watermarkConfig.watermarkSettings.scaleX Number - Horizontal scale coefficient.The default value is 1.\n
@param watermarkConfig.watermarkSettings.scaleY Number - Vertical scale coefficient.The default value is 1.\n
@param watermarkConfig.watermarkSettings.rotation Number - Rotation angle in degrees.The default value is 45.\n
@param watermarkConfig.watermarkSettings.opacity Number - Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.The default value is 100.\n
@param watermarkConfig.watermarkTextProperties object - Unique configuration for text watermarking.\n
@param watermarkConfig.watermarkTextProperties.font String - Font Name.The default value is "Microsoft Yahei".\n
@param watermarkConfig.watermarkTextProperties.fontSize Number - Font size.The default value is 20.\n
@param watermarkConfig.watermarkTextProperties.color String - Font color.The default value is "#000000".\n
@param watermarkConfig.watermarkTextProperties.fontStyle String - The default value is "normal". Available values are listed below.\n
1."normal":Watermark font style: normal.\n
2."underline":Watermark font style: with underline.\n
@param watermarkConfig.watermarkTextProperties.lineSpace Number - Line spacing.The default value is 10.\n
@param watermarkConfig.watermarkTextProperties.alignment String - Alignment. The default value is "center". Available values are listed below.\n
1."left":Left alignment. \n
2."center":Center alignment. \n
3."right":Right alignment. \n

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