LabelImageType Property

Type of image or printer commands the label is to be formatted in.

Syntax

 ezship.getLabelImageType([callback])
 ezship.setLabelImageType( labelImageType, [callback])

Possible Values

  0 (itNone), 
  1 (itEPL), 
  2 (itGIF), 
  3 (itJPG), 
  4 (itPDF), 
  5 (itPNG), 
  6 (itSPL), 
  7 (itTIF), 
  8 (itZPL), 
  9 (itStar), 
  10 (itEltron), 
  11 (itUniMark), 
  12 (itZebra)

Default Value

0

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 getLabelImageType([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 setLabelImageType([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

This element is required to indicate shipping label formatting and has to be set when the GetShipmentLabels method is called. The value selection depends on the printer type used to print the shipping label.

Valid image types are listed below:

Note that all USPS shipping types support sitTIF and sitPDF LabelImageTypes except stUSPSExpress ServiceType, which supports sitGIF and sitPDF.

The valid values when using Endicia are sitEPL, sitGIF, sitJPG, sitPNG, and sitZPL, when the ServiceType is stUSPSFirstClass, stUSPSPriority, stUSPSLibrary, stUSPSMedia, or stUSPSParcelPost otherwise, only sitGIF, sitJPG, and sitPNG are supported.

Data Type

Integer