OptimizeScannedPDFSettings Class Reference

Inheritance diagram for OptimizeScannedPDFSettings:

Public Member Functions
	constructor (other)
	Constructor, with another result information object. More...
	IsEmpty ()
	Check whether current object is empty or not. More...
	SetColorGrayImageCompressionMode (mode)
	Set compression mode used for optimizing color/gray images in the scanned PDF document. More...
	SetColorGrayImageCompressionQuality (quality)
	Set the quality for lossy compression modes, used for optimizing color/gray images in a scanned PDF document. More...
	SetMonoImageCompressionMode (mode)
	Set compression mode used for optimizing monochrome images in a scanned PDF document. More...
	SetOptimizedPages (pages)
	Set the pages which will be optimized. More...
Public Member Functions inherited from NativeObjectWrapper
	constructor (r)
	GetPointerAsNumber ()

Static Public Attributes
static	e_ScannedImageCompressHigh
	Enumeration for compression mode used for color or gray image. More...
static	e_ScannedImageCompressjpeg
	Compression mode: jpeg.
static	e_ScannedImageCompressjpeg2000LossLess
	Compression mode: jpeg2000 lossless.
static	e_ScannedImageCompressjpeg2000Lossy
	Compression mode: jpeg2000 lossy.
static	e_ScannedMonoImageCompressCCITT4
	Compression mode: CCITT Group 4.
static	e_ScannedMonoImageCompressHigh
	Compression mode: high.
static	e_ScannedMonoImageCompressjbig2LossLess
	Compression mode: jbig2 lossless.
static	e_ScannedMonoImageCompressjbig2Lossy
	Enumeration for compression mode used for monochrome image. More...

Detailed Description

This class represents settings for optimizing a scanned PDF document. It would be used in class Optimizer.

See also

Optimizer

Examples

/Users/ec2-user/gitlab-runner/builds/E-xKdhDoq/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

Member Function Documentation

constructor()

OptimizeScannedPDFSettings.constructor

(

other

)

Constructor, with another result information object.

Parameters

[in]

other

Another optimizer settings object.

IsEmpty()

OptimizeScannedPDFSettings.IsEmpty

(

)

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns

true means current object is empty, while false means not.

SetColorGrayImageCompressionMode()

OptimizeScannedPDFSettings.SetColorGrayImageCompressionMode

(

mode

)

Set compression mode used for optimizing color/gray images in the scanned PDF document.

For a newly constructed object, if this function is not called to set option, that means to use OptimizeScannedPDFSettings.e_ImageCompressjpeg as the default value of this option.

Parameters

[in]

mode

Image compression mode. Please refer to values starting from OptimizeScannedPDFSettings.e_ScannedImageCompressHigh and this should be one of these values.

Returns

None.

SetColorGrayImageCompressionQuality()

OptimizeScannedPDFSettings.SetColorGrayImageCompressionQuality

(

quality

)

Set the quality for lossy compression modes, used for optimizing color/gray images in a scanned PDF document.

For a newly constructed object, if this function is not called to set this option, that means to use 33 as the default value of this option.

Parameters

[in]

quality

Quality value for lossy compression modes, the value must between 0 and 100.

Note

This method only valid in OptimizeScannedPDFSettings.e_ScannedImageCompressHigh and OptimizeScannedPDFSettings.e_ScannedImageCompressjpeg compress mode.

Returns

None.

SetMonoImageCompressionMode()

OptimizeScannedPDFSettings.SetMonoImageCompressionMode

(

mode

)

Set compression mode used for optimizing monochrome images in a scanned PDF document.

For a newly constructed object, if this function is not called to set option, that means to use OptimizeScannedPDFSettings.e_ScannedMonoImageCompressjbig2Lossy as the default value of this option.

Parameters

[in]

mode

Image compression mode. Please refer to values starting from OptimizeScannedPDFSettings.e_ScannedMonoImageCompressjbig2Lossy and this should be one of these values.

Returns

None.

SetOptimizedPages()

OptimizeScannedPDFSettings.SetOptimizedPages

(

pages

)

Set the pages which will be optimized.

For a newly constructed object,if this function is not called. all pages will be optimized.

Parameters

[in]

pages

The Specify pages, If pages doesn't not add pages index means all pages will be optimized.

Returns

None.

Member Data Documentation

e_ScannedImageCompressHigh

OptimizeScannedPDFSettings.e_ScannedImageCompressHigh

static

Enumeration for compression mode used for color or gray image.

Values of this enumeration should be used alone.

Compression mode: high.

e_ScannedMonoImageCompressjbig2Lossy

OptimizeScannedPDFSettings.e_ScannedMonoImageCompressjbig2Lossy

static

Enumeration for compression mode used for monochrome image.

Values of this enumeration should be used alone.

Compression mode: jbig2 lossy.