LabelImageType Property

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

Syntax

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

Possible Values

  0 (fitPDF), 
  1 (fitPNG), 
  2 (fitEltron), 
  3 (fitZebra), 
  4 (fitUniMark)

Default Value

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 the format that the shipping label should be printed in. This must be set when either GetPackageLabel or GetShipmentLabels are called. The values for the thermal printers indicate the type of printer that is being used.

Valid image types and their meanings with the corresponding usage are listed below:


fitPDF (0)	PDF format (plain paper only - laser printer)
fitPNG (1)	PNG image (plain paper only - laser printer)
fitEltron (2)	Thermal only (to be used with Eltron Orion (EPL2) or Eltron Eclipse (EPL2) printers)
fitZebra (3)	Thermal only (to be used with Zebra ZPLII printer series)
fitUniMark (4)	Thermal only (to be used with Unimark printer series)

Note: To generate PDF labels, you will need Adobe Reader 6.0 or higher, and the printer driver configuration set to 'none' for print scaling.

There are two types of shipping labels supported:

plain paper (to be used in laser printers only. In this case, possible values for the LabelImageType are PNG or PDF),
thermal (to be used in thermal printers only. In this case, possible values for the LabelImageType are ELTRON, ZEBRA, or UNIMARK).

While the content of each of these labels is the same, using the correct image type for the work environment the application will be used in is essential.

You may use the LabelStockType config to specify the size of the label. By default, the class will request a 4x6 label.

Data Type

Integer