PDFTron pdfnet-node Class: Image

new Image()

Image class provides common methods for working with PDF images. Note: PDF::Element contains a similar interface used to access image data. To create the Image object from image PDF::Element, pass the Element's SDF/Cos dictionary to Image constructor (i.e. Image image(element->GetXObject()) )

Members

<static> InputFilter

Type:

number

Properties:

Name	Type	Description
`e_none`	number
`e_jpeg`	number
`e_jp2`	number
`e_flate`	number
`e_g3`	number
`e_g4`	number
`e_ascii_hex`	number

Methods

<static> createDirectFromMemory(doc, buf, width, height, bpc, color_space, input_format)

Directly embed the image that is already compressed using the Image::InputFilter format. The function can be used to pass-through pre-compressed image data.

Parameters:

Name	Type	Description
`doc`	PDFNet.PDFDoc \| PDFNet.SDFDoc \| PDFNet.FDFDoc	A document to which the image should be added. The 'Doc' object can be obtained using Obj::GetDoc() or PDFDoc::GetSDFDoc().
`buf`	ArrayBuffer \| Int8Array \| Uint8Array \| Uint8ClampedArray	The stream or buffer containing compressed image data. The compression format must match the input_format parameter.
`width`	number	The width of the image, in samples.
`height`	number	The height of the image, in samples.
`bpc`	number	The number of bits used to represent each color component.
`color_space`	PDFNet.ColorSpace	The color space in which image samples are specified.
`input_format`	number	PDFNet.Image.InputFilter = { e_none : 0 e_jpeg : 1 e_jp2 : 2 e_flate : 3 e_g3 : 4 e_g4 : 5 e_ascii_hex : 6 } Image::InputFilter describing the format of pre-compressed image data.

Returns:

A promise that resolves to PDF::Image object representing the embedded image.

Type: Promise.<PDFNet.Image>

<static> createDirectFromStream(doc, image_data, width, height, bpc, color_space, input_format)

Embed the raw image data taking into account specified compression hints. Note: see the above method for details.

Parameters:

Name	Type	Description
`doc`	PDFNet.PDFDoc \| PDFNet.SDFDoc \| PDFNet.FDFDoc
`image_data`	PDFNet.FilterReader
`width`	number
`height`	number
`bpc`	number
`color_space`	PDFNet.ColorSpace
`input_format`	number	PDFNet.Image.InputFilter = { e_none : 0 e_jpeg : 1 e_jp2 : 2 e_flate : 3 e_g3 : 4 e_g4 : 5 e_ascii_hex : 6 }

Returns:

A promise that resolves to an object of type: "PDFNet.Image"

Type: Promise.<PDFNet.Image>

<static> createFromFile(doc, filename [, encoder_hints])

Create and embed an Image from an external file taking into account specified compression hints. By default the function will either pass-through data preserving the original compression or will compress data using Flate compression. It is possible to fine tune compression or to select a different compression algorithm using 'encoder_hints' object.

Parameters:

Name	Type	Argument	Description
`doc`	PDFNet.PDFDoc \| PDFNet.SDFDoc \| PDFNet.FDFDoc		A document to which the image should be added. To obtain SDF::Doc from PDFDoc use PDFDoc::GetSDFDoc() or Obj::GetDoc().
`filename`	string		The name of the image file. Currently supported formats are JPEG, PNG, GIF, TIFF, BMP, EMF, and WMF. Other raster formats can be embedded by decompressing image data and using other versions of Image::Create(...) method.
`encoder_hints`	PDFNet.Obj	<optional>	An optional SDF::Obj containing a hint (or an SDF::Array of hints) that could be used to select a specific compression method and compression parameters. For a concrete example of how to create encoder hints, please take a look at JBIG2Test and AddImage sample projects. The image encoder accepts the following hints: /JBIG2; SDF::Name("JBIG2"), An SDF::Name Object with value equal to "JBIG2". If the image is monochrome (i.e. bpc == 1), the encoder will compress the image using JBIG2Decode filter. Note that JBIG2 compression is not recommended for use on scanned text/financial documents or equivalent since its lossless nature can lead to similar looking numbers or characters being replaced. [/JBIG2 /Threshold 0.6 /SharePages 50] Compress a monochrome image using lossy JBIG2Decode compression with the given image threshold and by sharing segments from a specified number of pages. The threshold is a floating point number in the range from 0.4 to 0.9. Increasing the threshold value will increase image quality, but may increase the file size. The default value for threshold is 0.85. "SharePages" parameter can be used to specify the maximum number of pages sharing a common 'JBIG2Globals' segment stream. Increasing the value of this parameter improves compression ratio at the expense of memory usage. - [/CCITT] Compress a monochrome (i.e. bpc == 1) image using CCITT Group 4 compression. This algorithm typically produces larger output than JBIG2, but is lossless. This makes it much more suitable for scanned text documents. CCITT is the best option for more general monochrome compression use cases, since JBIG2 has potential to change image content. [/JPEG] Use JPEG compression with default compression. [/JPEG /Quality 60] Use JPEG compression with given quality setting. The "Quality" value is expressed on the 0..100 scale. [/JPEG2000] Use JPEG2000 compression to compress a RGB or a grayscale image. [/JP2] Use JPEG2000 compression with JP2 encoding. JP2 does not support CMYK images. [/Flate] Use Flate compression with maximum compression at the expense of speed. [/Flate /Level 9] Use Flate compression using specified compression level. Compression "Level" must be a number between 0 and 9: 1 gives best speed, 9 gives best compression, 0 gives no compression at all (the input data is simply copied a block at a time). /RAW or [/RAW] The encoder will not use any compression method and the image will be stored in the raw format.

Returns:

A promise that resolves to PDF::Image object representing the embedded image. Note: For C++ developers: Current document does not take the ownership of the encoder_hints object. Therefore it is a good programming practice to create encoder_hints object on the stack.

Type: Promise.<PDFNet.Image>

<static> createFromMemory(doc, buf, width, height, bpc, color_space [, encoder_hints])

Create and embed an Image. Embed the raw image data taking into account specified compression hints. By default the function will compress all images using Flate compression. It is possible to fine tune compression or to select a different compression algorithm using 'encoder_hints' object.

Parameters:

Name	Type	Argument	Description
`doc`	PDFNet.PDFDoc \| PDFNet.SDFDoc \| PDFNet.FDFDoc		A document to which the image should be added. The 'Doc' object can be obtained using Obj::GetDoc() or PDFDoc::GetSDFDoc().
`buf`	ArrayBuffer \| Int8Array \| Uint8Array \| Uint8ClampedArray		The stream or buffer containing image data. The image data must not be compressed and must follow PDF format for sample representation (please refer to section 4.8.2 'Sample Representation' in PDF Reference Manual for details).
`width`	number		The width of the image, in samples.
`height`	number		The height of the image, in samples.
`bpc`	number		The number of bits used to represent each color component.
`color_space`	PDFNet.ColorSpace		The color space in which image samples are represented.
`encoder_hints`	PDFNet.Obj	<optional>	An optional parameter that can be used to fine tune compression or to select a different compression algorithm. See Image::Create() for details.

Returns:

A promise that resolves to PDF::Image object representing the embedded image.

Type: Promise.<PDFNet.Image>

<static> createFromMemory2(doc, buf [, encoder_hints])

Create and embed an Image. Embed the raw image data taking into account specified compression hints. Note: see Image::Create for details.

Parameters:

Name	Type	Argument
`doc`	PDFNet.PDFDoc \| PDFNet.SDFDoc \| PDFNet.FDFDoc
`buf`	ArrayBuffer \| Int8Array \| Uint8Array \| Uint8ClampedArray
`encoder_hints`	PDFNet.Obj	<optional>

Returns:

A promise that resolves to an object of type: "PDFNet.Image"

Type: Promise.<PDFNet.Image>

<static> createFromObj( [image_xobject])

Create an image from an existing image represented as a SDF/Cos object. Note: To create the Image object from image PDF::Element, pass the Element's SDF/Cos dictionary to Image constructor (i.e. Image image(element->GetXObject()))

Parameters:

Name	Type	Argument	Description
`image_xobject`	PDFNet.Obj	<optional>

Returns:

A promise that resolves to an object of type: "PDFNet.Image"

Type: Promise.<PDFNet.Image>

<static> createFromStream(doc, image_data, width, height, bpc, color_space [, encoder_hints])

Create and embed an Image. Embed the raw image data taking into account specified compression hints. Note: see Image::Create for details.

Parameters:

Name	Type	Argument
`doc`	PDFNet.PDFDoc \| PDFNet.SDFDoc \| PDFNet.FDFDoc
`image_data`	PDFNet.FilterReader
`width`	number
`height`	number
`bpc`	number
`color_space`	PDFNet.ColorSpace
`encoder_hints`	PDFNet.Obj	<optional>

Returns:

A promise that resolves to an object of type: "PDFNet.Image"

Type: Promise.<PDFNet.Image>

<static> createFromStream2(doc, image_data [, encoder_hints])

Create and embed an Image. Embed the raw image data taking into account specified compression hints. Note: see Image::Create for details. Note: PDFNet takes ownership of the filter

Parameters:

Name	Type	Argument
`doc`	PDFNet.PDFDoc \| PDFNet.SDFDoc \| PDFNet.FDFDoc
`image_data`	PDFNet.Filter
`encoder_hints`	PDFNet.Obj	<optional>

Returns:

A promise that resolves to an object of type: "PDFNet.Image"

Type: Promise.<PDFNet.Image>

<static> createFromURL(doc, url [, encoder_hints] [, options])

This function will fully download the image url as a memory buffer and embed it in the supplied PDFDoc.

Parameters:

Name Type Argument Description

doc PDFNet.PDFDoc | PDFNet.SDFDoc | PDFNet.FDFDoc the PDF document in which to embed the image

url string The image url to download and embed.

encoder_hints PDFNet.Obj <optional>

options

object

Additional options

Properties

Name	Type	Description
`withCredentials`	boolean	Whether to set the withCredentials property on the XMLHttpRequest
`customHeaders`	object	An object containing custom HTTP headers to be used when downloading the document

Returns:

A promise that resolves to an object of type: "Image"

Type: Promise.<PDFNet.Image>

<static> createImageMask(doc, buf, width, height [, encoder_hints])

Create and embed an ImageMask. Embed the raw image data taking into account specified compression hints. The ImageMask can be used as a stencil mask for painting in the current color or as an explicit mask specifying which areas of the image to paint and which to mask out. One of the most important uses of stencil masking is for painting character glyphs represented as bitmaps.

Parameters:

Name	Type	Argument	Description
`doc`	PDFNet.PDFDoc \| PDFNet.SDFDoc \| PDFNet.FDFDoc		A document to which the image should be added. The 'Doc' object can be obtained using Obj::GetDoc() or PDFDoc::GetSDFDoc().
`buf`	ArrayBuffer \| Int8Array \| Uint8Array \| Uint8ClampedArray		The stream or buffer containing image data stored in 1 bit per sample format. The image data must not be compressed and must follow PDF format for sample representation (please refer to section 4.8.2 'Sample Representation' in PDF Reference Manual for details).
`width`	number		The width of the image, in samples.
`height`	number		The height of the image, in samples.
`encoder_hints`	PDFNet.Obj	<optional>	An optional parameter that can be used to fine tune compression or to select a different compression algorithm. See Image::Create() for details.

Returns:

A promise that resolves to PDF::Image object representing the embedded ImageMask.

Type: Promise.<PDFNet.Image>

<static> createImageMaskFromStream(doc, image_data, width, height [, encoder_hints])

Create and embed an ImageMask. Note: see Image::CreateImageMask for details.

Parameters:

Name	Type	Argument
`doc`	PDFNet.PDFDoc \| PDFNet.SDFDoc \| PDFNet.FDFDoc
`image_data`	PDFNet.FilterReader
`width`	number
`height`	number
`encoder_hints`	PDFNet.Obj	<optional>

Returns:

A promise that resolves to an object of type: "PDFNet.Image"

Type: Promise.<PDFNet.Image>

<static> createSoftMask(doc, buf, width, height, bpc [, encoder_hints])

Create and embed a Soft Mask. Embed the raw image data taking into account specified compression hints. A soft-mask image (see "Soft-Mask Images" in PDF Reference Manual) is used as a source of mask shape or mask opacity values in the transparent imaging model.

Parameters:

Name	Type	Argument	Description
`doc`	PDFNet.PDFDoc \| PDFNet.SDFDoc \| PDFNet.FDFDoc		A document to which the image should be added. The 'Doc' object can be obtained using Obj::GetDoc() or PDFDoc::GetSDFDoc().
`buf`	ArrayBuffer \| Int8Array \| Uint8Array \| Uint8ClampedArray		The stream or buffer containing image data represented in DeviceGray color space (i.e. one component per sample). The image data must not be compressed and must follow PDF format for sample representation (please refer to section 4.8.2 'Sample Representation' in PDF Reference Manual for details).
`width`	number		The width of the image, in samples.
`height`	number		The height of the image, in samples.
`bpc`	number		The number of bits used to represent each color component.
`encoder_hints`	PDFNet.Obj	<optional>	An optional parameter that can be used to fine tune compression or to select a different compression algorithm. See Image::Create() for details. Note: this feature is available only in PDF 1.4 and higher.

Returns:

A promise that resolves to an object of type: "PDFNet.Image"

Type: Promise.<PDFNet.Image>

<static> createSoftMaskFromStream(doc, image_data, width, height, bpc [, encoder_hints])

Create and embed a Soft Mask. Embed the raw image data taking into account specified compression hints. Note: see Image::CreateSoftMask for details.

Parameters:

Name	Type	Argument
`doc`	PDFNet.PDFDoc \| PDFNet.SDFDoc \| PDFNet.FDFDoc
`image_data`	PDFNet.FilterReader
`width`	number
`height`	number
`bpc`	number
`encoder_hints`	PDFNet.Obj	<optional>

Returns:

A promise that resolves to an object of type: "PDFNet.Image"

Type: Promise.<PDFNet.Image>

copy()

Copy Constructor

Returns:

A promise that resolves to an object of type: "PDFNet.Image"

Type: Promise.<PDFNet.Image>

export(filename)

Saves this image to a file. The output image format (TIFF, JPEG, or PNG) will be automatically selected based on the properties of the embedded image. For example, if the embedded image is using CCITT Fax compression, the output format will be TIFF. Similarly, if the embedded image is using JPEG compression the output format will be JPEG. If your application needs to explicitly control output image format you may want to use ExportAsTiff() or ExportAsPng().

Parameters:

Name	Type	Description
`filename`	string	string that specifies the path name for the saved image. The filename should not include the extension which will be appended to the filename string based on the output format.

Returns:

A promise that resolves to the number indicating the selected image format: (0 PNG, 1 TIF, 2 JPEG).

Type: Promise.<number>

exportAsPng(filename)

Saves this image to a PNG file.

Parameters:

Name	Type	Description
`filename`	string	string that specifies the path name for the saved image. The filename should include the file extension

Returns:

Type: Promise.<void>

exportAsPngFromStream(writer)

Saves this image to a PNG output stream.

Parameters:

Name	Type	Description
`writer`	PDFNet.FilterWriter	FilterWriter used to write to the output stream.

Returns:

Type: Promise.<void>

exportAsTiff(filename)

Saves this image to a TIFF file.

Parameters:

Name	Type	Description
`filename`	string	string that specifies the path name for the saved image. The filename should include the file extension

Returns:

Type: Promise.<void>

exportAsTiffFromStream(writer)

Saves this image to a TIFF output stream.

Parameters:

Name	Type	Description
`writer`	PDFNet.FilterWriter	FilterWriter used to write to the output stream.

Returns:

Type: Promise.<void>

exportFromStream(writer)

Saves this image to the output stream. (0 PNG, 1 TIF, 2 JPEG).

Parameters:

Name	Type	Description
`writer`	PDFNet.FilterWriter	A pointer to FilterWriter used to write to the output stream. If the parameter is null, nothing will be written to the output stream, but the function returns the format identifier.

Returns:

A promise that resolves to the number indicating the selected image format: Note: see the overloaded Image::Export method for more information.

Type: Promise.<number>

getBitsPerComponent()

Returns:

A promise that resolves to the number of bits used to represent each color component. Only a single value may be specified; the number of bits is the same for all color components. Valid values are 1, 2, 4, 8, and 16.

Type: Promise.<number>

getComponentNum()

Returns:

A promise that resolves to the number of color components per sample.

Type: Promise.<number>

getDecodeArray()

Returns:

A promise that resolves to decode array or NULL if the parameter is not specified. A decode object is an array of numbers describing how to map image samples into the range of values appropriate for the images color space . If ImageMask is true, the array must be either [0 1] or [1 0]; otherwise, its length must be twice the number of color components required by ColorSpace. Default value depends on the color space, See Table 4.36 in PDF Ref. Manual.

Type: Promise.<PDFNet.Obj>

getImageColorSpace()

Returns:

A promise that resolves to the SDF object representing the color space in which image samples are specified or NULL if: the image is an image mask or is compressed using JPXDecode with missing ColorSpace entry in image dictionary. The returned color space may be any type of color space except Pattern.

Type: Promise.<PDFNet.ColorSpace>

getImageData()

Returns:

A promise that resolves to a stream (filter) containing decoded image data

Type: Promise.<PDFNet.Filter>

getImageDataSize()

Returns:

A promise that resolves to the size of image data in bytes

Type: Promise.<number>

getImageHeight()

Returns:

A promise that resolves to the height of the image, in samples.

Type: Promise.<number>

getImageRenderingIntent()

Returns:

A promise that resolves to the color rendering intent to be used in rendering the image.

Type: Promise.<number>

Example

Return value enum:
<pre>
PDFNet.GState.RenderingIntent = {
	e_absolute_colorimetric : 0
	e_relative_colorimetric : 1
	e_saturation : 2
	e_perceptual : 3
}
</pre>

getImageWidth()

Returns:

A promise that resolves to the width of the image, in samples.

Type: Promise.<number>

getMask()

Returns:

A promise that resolves to an image XObject defining an image mask to be applied to this image (See 'Explicit Masking', 4.8.5), or an array specifying a range of colors to be applied to it as a color key mask (See 'Color Key Masking'). If IsImageMask() return true, this method will return NULL.

Type: Promise.<PDFNet.Obj>

getSDFObj()

Returns:

A promise that resolves to the underlying SDF/Cos object

Type: Promise.<PDFNet.Obj>

getSoftMask()

Returns:

A promise that resolves to an image XObject defining a Soft Mask to be applied to this image (See section 7.5.4 'Soft-Mask Images' in PDF Reference Manual), or NULL if the image does not have the soft mask.

Type: Promise.<PDFNet.Obj>

isImageInterpolate()

Returns:

A promise that resolves to a boolean indicating whether image interpolation is to be performed.

Type: Promise.<boolean>

isImageMask()

Returns:

A promise that resolves to a boolean indicating whether the inline image is to be treated as an image mask.

Type: Promise.<boolean>

isValid()

Returns:

A promise that resolves to whether this is a valid raster image. If the function returns false the underlying SDF/Cos object is not a valid raster image and this Image object should be treated as null.

Type: Promise.<boolean>

setMask(image_mask)

Set an Explicit Image Mask.

Parameters:

Name	Type	Description
`image_mask`	PDFNet.Image	An Image object which serves as an explicit mask for the base (this) image. The base image and the image mask need not have the same resolution (Width and Height values), but since all images are defined on the unit square in user space, their boundaries on the page will coincide; that is, they will overlay each other. The image mask indicates which places on the page are to be painted and which are to be masked out (left unchanged). Unmasked areas are painted with the corresponding portions of the base image; masked areas are not. Note: image_mask must be a valid image mask (i.e. image_mask.IsImageMask() must return true.

Returns:

Type: Promise.<void>

setMaskWithObj(mask)

Set a Color Key Mask.

Parameters:

Name	Type	Description
`mask`	PDFNet.Obj	is an Cos/SDF array specifying a range of colors to be masked out. Samples in the image that fall within this range are not painted, allowing the existing background to show through. The effect is similar to that of the video technique known as chroma-key. For details of the array format please refer to section 4.8.5 'Color Key Masking' in PDF Reference Manual. Note: the current document takes the ownership of the given SDF object.

Returns:

Type: Promise.<void>

setSoftMask(soft_mask)

Set a Soft Mask.

Parameters:

Name	Type	Description
`soft_mask`	PDFNet.Image	is a subsidiary Image object defining a soft-mask image (See section 7.5.4 'Soft-Mask Images' in PDF Reference Manual) to be used as a source of mask shape or mask opacity values in the transparent imaging model. The alpha source parameter in the graphics state determines whether the mask values are interpreted as shape or opacity.

Returns:

Type: Promise.<void>