PdfSource

Syntax

interface PdfSource extends Source {
    convertMode: EnumConvertMode;   
    password?: string;  
    renderOptions?: {
        renderAnnotations?: EnumAnnotationRenderMode; 
        resolution?: number;  
        maxWidth?: number;
        maxHeight?: number;
        renderGrayscale?: boolean;  
    };
}

Extends

Source

Attributes

convertMode

Specify PDF convert mode. It affects whether PDF elements like text layers are loaded and the image for display and saving. Please refer to EnumConvertMode.

Default value: Dynamsoft.DDV.EnumConvertMode.CM_AUTO

Related to the renderOptions attribute if the actual mode is rendering.

password

If a password is required to open the PDF, please set it here.

Default value: "".

renderOptions

renderAnnotations

Specify how to load the annotations. Please refer to EnumAnnotationRenderMode.

Only take effects when convertMode is set to Dynamsoft.DDV.EnumConvertMode.CM_RENDERALL or Dynamsoft.DDV.EnumConvertMode.CM_AUTO(Dynamsoft.DDV.EnumConvertMode.CM_RENDERALL in fact).

Default value: Dynamsoft.DDV.EnumAnnotationRenderMode.NO_ANNOTATIONS

resolution

PDF DPI. Only effective when the actual convertMode is rendering.

Since v4.0 has added high-fidelity rendering, it does not affect the image displayed and only affects the image saved using methods like saveToJpeg().

Default value: 200

maxWidth

Maximum width of the image to be rendered.

In pixels. 0 means no limit. Default value: 0

maxHeight

Maximum height of the image to be rendered.

In pixels. 0 means no limit. Default value: 0

renderGrayscale

Whether rasterize the PDF in grayscale.

Default value: false

Only take effects when convertMode is set to Dynamsoft.DDV.EnumConvertMode.CM_RENDERALL or Dynamsoft.DDV.EnumConvertMode.CM_AUTO(Dynamsoft.DDV.EnumConvertMode.CM_RENDERALL in fact).

loadSource()