CheckImageCompression Property

A code that identifies the algorithm or method used to compress the images stored in the FrontImageData and BackImageData properties.

Syntax

 check21.getCheckImageCompression(index, [callback])
 check21.setCheckImageCompression(index,  checkImageCompression, [callback])

Possible Values

  0 (icFacsimile), 
  1 (icJPEG), 
  2 (icABIC), 
  21 (icPNG), 
  22 (icJBIG), 
  23 (icJPEG2000)

Default Value

1

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getCheckImageCompression([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setCheckImageCompression([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

A code that identifies the algorithm or method used to compress the images stored in the CheckFrontImageData and CheckBackImageData properties. Values 0-20 may be used without a pre-existing agreement. Values 21-99 shall only be used when an agreement exists indicating that sender and receiver both support the specified image compression method and the method is specified below or on the X9 web site. This property is part of the Image View Detail record (type 50), and may be any of the values below:

The index parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

Integer