Class PDFNet.PDFDraw
PDFNet.PDFDraw
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
PDFNet.PDFDraw(id)
PDFDraw contains methods for converting PDF pages to images and to Bitmap objects.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
PDFNet.PDFDraw.create(dpi)
PdFDraw constructor and destructor
|
|
destroy()
Frees the native memory of the object.
|
|
|
setAntiAliasing(enable_aa)
Enable or disable anti-aliasing.
|
|
|
setCaching(enabled)
enables or disables caching.
|
|
|
setColorPostProcessMode(mode)
Set the color post processing transformation.
|
|
|
setDefaultPageColor(r, g, b)
sets the default color of the page backdrop.
|
|
|
setDPI(dpi)
Sets the output image resolution.
|
|
|
setDrawAnnotations(render_annots)
Enable or disable annotation and forms rendering.
|
|
|
setFlipYAxis(flip_y)
Flips the vertical (i.e.
|
|
|
setGamma(exp)
Sets the gamma factor used for anti-aliased rendering.
|
|
|
setHighlightFields(highlight)
Enable or disable highlighting form fields.
|
|
|
setImageSize(width, height, preserve_aspect_ratio)
SetImageSize can be used instead of SetDPI() to adjust page scaling so that
image fits into a buffer of given dimensions.
|
|
|
setImageSmoothing(smoothing_enabled, hq_image_resampling)
Enable or disable image smoothing.
|
|
|
setOCGContext(ctx)
sets the Optional Content Group (OCG) context that should be used when
rendering the page.
|
|
|
setOverprint(op)
enable or disable support for overprint and overprint simulation.
|
|
|
setPageBox(region)
Selects the page box/region to rasterize.
|
|
|
setPageTransparent(is_transparent)
sets the page color to transparent.
|
|
|
setPathHinting(enable_hinting)
Enable or disable path hinting.
|
|
|
setPrintMode(is_printing)
tells the rasterizer to render the page 'print' mode.
|
|
|
setRasterizerType(type)
Sets the core graphics library used for rasterization and
rendering.
|
|
|
setRotate(angle)
Sets the rotation value for this page.
|
|
|
setThinLineAdjustment(grid_fit, stroke_adjust)
Set thin line adjustment parameters.
|
Class Detail
PDFNet.PDFDraw(id)
PDFDraw contains methods for converting PDF pages to images and to Bitmap objects.
Utility methods are provided to export PDF pages to various raster formats as well
as to convert pages to GDI+ bitmaps for further manipulation or drawing.
- Parameters:
- id
Method Detail
<static>
{PDFDraw}
PDFNet.PDFDraw.create(dpi)
PdFDraw constructor and destructor
- Parameters:
- {number} dpi
- Default resolution used to rasterize pages. If the parameter is not specified, the initial resolution is 92 dots per inch. DPI parameter can be modified at any time using PDFDraw::SetDPI() method.
- Returns:
- {PDFDraw} A promise that resolves to an object of type: "PDFDraw" (generated documentation)
destroy()
Frees the native memory of the object.
setAntiAliasing(enable_aa)
Enable or disable anti-aliasing.
Anti-Aliasing is a technique used to improve the visual
quality of images when displaying them on low resolution
devices (for example, low DPI computer monitors).
- Parameters:
- {boolean} enable_aa
- if true anti-aliasing will be enabled.
setCaching(enabled)
enables or disables caching. Caching can improve the rendering performance in cases
where the same page will be drawn multiple times.
- Parameters:
- {boolean} enabled
- if true PDFRasterizer will cache frequently used graphics objects.
setColorPostProcessMode(mode)
Set the color post processing transformation.
This transform is applied to the rasterized bitmap as the final step
in the rasterization process, and is applied directly to the resulting
bitmap (disregarding any color space information). Color post
processing only supported for RGBA output.
- Parameters:
- {number} mode
- is the specific transform to be applied
setDefaultPageColor(r, g, b)
sets the default color of the page backdrop.
- Parameters:
- {number} r
- the red component of the page backdrop color.
- {number} g
- the green component of the page backdrop color.
- {number} b
- the blue component of the page backdrop color.
setDPI(dpi)
Sets the output image resolution.
DPI stands for Dots Per Inch. This parameter is used to specify the output
image size and quality. A typical screen resolution for monitors these days is
92 DPI, but printers could use 200 DPI or more.
- Parameters:
- {number} dpi
- value to set the image resolution to. Higher value = higher resolution.
setDrawAnnotations(render_annots)
Enable or disable annotation and forms rendering. By default, all annotations
and form fields are rendered.
- Parameters:
- {boolean} render_annots
- True to draw annotations, false otherwise.
setFlipYAxis(flip_y)
Flips the vertical (i.e. Y) axis of the image.
- Parameters:
- {boolean} flip_y
- true to flip the Y axis, false otherwise. For compatibility with most raster formats 'flip_y' is true by default.
setGamma(exp)
Sets the gamma factor used for anti-aliased rendering.
- Parameters:
- {number} exp
- is the exponent value of gamma function. Typical values are in the range from 0.1 to 3. Gamma correction can be used to improve the quality of anti-aliased image output and can (to some extent) decrease the appearance common anti-aliasing artifacts (such as pixel width lines between polygons).
setHighlightFields(highlight)
Enable or disable highlighting form fields. Default is disabled.
- Parameters:
- {boolean} highlight
- true to highlight, false otherwise.
setImageSize(width, height, preserve_aspect_ratio)
SetImageSize can be used instead of SetDPI() to adjust page scaling so that
image fits into a buffer of given dimensions.
If this function is used, DPI will be calculated dynamically for each
page so that every page fits into the buffer of given dimensions.
- Parameters:
- {number} width
- The width of the image, in pixels/samples.
- {number} height
- The height of the image, in pixels/samples.
- {boolean} preserve_aspect_ratio
- True to preserve the aspect ratio, false otherwise. By default, preserve_aspect_ratio is true.
setImageSmoothing(smoothing_enabled, hq_image_resampling)
Enable or disable image smoothing.
The rasterizer allows a tradeoff between rendering quality and rendering speed.
This function can be used to indicate the preference between rendering speed and quality.
- Parameters:
- {boolean} smoothing_enabled
- True to enable image smoothing, false otherwise.
- {boolean} hq_image_resampling
- True to use a higher quality (but slower) smoothing algorithm
setOCGContext(ctx)
sets the Optional Content Group (OCG) context that should be used when
rendering the page. This function can be used to selectively render optional
content (such as PDF layers) based on the states of optional content groups
in the given context.
- Parameters:
- {OCGContext} ctx
- Optional Content Group (OCG) context, or NULL if the rasterizer should render all content on the page.
setOverprint(op)
enable or disable support for overprint and overprint simulation.
Overprint is a device dependent feature and the results will vary depending on
the output color space and supported colorants (i.e. CMYK, CMYK+spot, RGB, etc).
- Parameters:
- {number} op
- e_op_on: always enabled; e_op_off: always disabled; e_op_pdfx_on: enabled for PDF/X files only.
setPageBox(region)
Selects the page box/region to rasterize.
- Parameters:
- {number} region
- Page box to rasterize. By default, PDFDraw will rasterize page crop box.
setPageTransparent(is_transparent)
sets the page color to transparent.
- Parameters:
- {boolean} is_transparent
- If true, page's backdrop color will be transparent. If false, the page's backdrop will be a opaque white.
setPathHinting(enable_hinting)
Enable or disable path hinting.
- Parameters:
- {boolean} enable_hinting
- if true path hinting will be enabled. Path hinting is used to slightly adjust paths in order to avoid or alleviate artifacts of hair line cracks between certain graphical elements. This option is turned on by default.
setPrintMode(is_printing)
tells the rasterizer to render the page 'print' mode. Certain page elements
(such as annotations or OCG-s) are meant to be visible either on the screen or
on the printed paper but not both. A common example, is the "Submit" button on
electronic forms.
- Parameters:
- {boolean} is_printing
- set to true if the page should be rendered in print mode.
setRasterizerType(type)
Sets the core graphics library used for rasterization and
rendering. Using this method it is possible to quickly switch
between different implementations. By default, PDFDraw uses
the built-in, platform independent rasterizer.
- Parameters:
- {number} type
- Rasterizer type.
setRotate(angle)
Sets the rotation value for this page.
- Parameters:
- {number} angle
- Rotation value to be set for a given page. Must be one of the Page::Rotate values.
setThinLineAdjustment(grid_fit, stroke_adjust)
Set thin line adjustment parameters.
- Parameters:
- {boolean} grid_fit
- if true (horizontal/vertical) thin lines will be snapped to integer pixel positions. This helps make thin lines look sharper and clearer. This option is turned off by default and it only works if path hinting is enabled.
- {boolean} stroke_adjust
- if true auto stroke adjustment is enabled. Currently, this would make lines with sub-pixel width to be one-pixel wide. This option is turned on by default.