Print job

The simplest form deselects any existing jobs, or selects a single label, but it can also set up a database driven job. The job can either replace the existing job, or add it to a queue.

All parameters are optional, but there needs to be one to specify the label, i.e. labelName, labelColumn or labelData. If any of the table parameters is used, then tableName, keyColumn and key must all be set.

Parameter	Type	Description
alignment	string	Alignment of the label within targetLength: START, CENTER, or END.
autoPrintGap	distance	Auto-print gap. A plain number is interpreted as nanometers.
autoPrintInterval	distance	Auto-print interval. A plain number is interpreted as nanometers.
checkpoint	boolean	See the seekPrintQueueCheckpoint API method.
copies	number	Limit the number of copies to print. Default is unlimited.
copiesColumn	string	Table column where the number of copies to print is available.
description	string	Description which will be displayed on the Overview tab in the user inteface.
firstRow	number	First table row index to use when selecting with tableName and labelName. Defaults to 0.
freeze	boolean	If true, then the label will be frozen, i.e. the current label content, as well as all dynamic text, will be copies and unaffected by any changes. It will also cause all used counters to increment immediately. The default value is the value of the queue parameter.
hAlign	string	Along-web alignment of the label within targetLength, taking precedence over alignment when set: LEFT, CENTER, or RIGHT. LEFT/RIGHT map to START/END according to the print direction. v5.0
hOffset	distance	Shifts the print along the web. A plain number is interpreted as millimeters. A positive value always moves the print to the right regardless of the print direction. Applied only when targetLength is set, and clamped so the net change to position is never negative. v5.0
key	string	Value to search for in the keyColumn of the table.
keyColumn	string	Column in which to search to select the row to use.
labelName	string	The name of a label.
labelData	Label	A complete label object.
labelColumn	string	Table column where the label name is available.
printDelay	distance	Per-job print delay override. A plain number is interpreted as millimeters. v4.5
printedColumn	string	Table column where to number of printed labels is stored. The value in this column will be incremented when printing.
queue	boolean	If true, then the label will be added to the end of the queue of jobs, else it will replace any existing queue with this job.
rowCount	number	Number of table rows to use when selecting with tableName and labelName. Defaults to all remaining rows from firstRow.
repeatPrintGap	distance	Repeat print gap. A plain number is interpreted as nanometers.
repeatPrintInterval	distance	Repeat print interval. A plain number is interpreted as nanometers.
roundRobin	boolean	If set, then the print job will be moved to the back of the queue when completed.
stepCounters	boolean	If true, step counters when the job is frozen. Default is true.
tableName	string	The name of a table.
targetHeight	distance	Target print height across the web. A plain number is interpreted as millimeters. Used together with vAlign. v5.0
targetLength	distance	Target print length. A plain number is interpreted as millimeters. Used together with alignment. v4.5
vAlign	string	Cross-web alignment of the label within targetHeight: TOP, CENTER, or BOTTOM. Defaults to BOTTOM, which matches the zero-offset position. v5.0

Auto-print

Auto-print is a feature that automatically triggers a job after the previous job is completed, and the configured gap/interval has elapsed.

tip

In v4.2.0 through v4.3.x, if there were no other print jobs waiting in the queue, the job was automatically printed once the configured gap/interval had elapsed. Since v4.4.0 this is no longer the case: if the queue is empty, the auto-print parameters are ignored.

Examples

Deselect all print jobs (clearing the queue):

{}

Select a single label "MyLabel":

{"labelName": "MyLabel"}

Select a single label "MyLabel", limit to a single print, and add to the end of the queue:

{
  "labelName": "MyLabel",
  "copies": 1,
  "queue": true
}

Search the table "MyTable" in the column "Product" for "MyProduct", and select the label from the column "Label":

{
  "tableName": "MyTable",
  "keyColumn": "Product",
  "key": "MyProduct",
  "labelColumn": "Label"
}