Global

Type Definitions

jQueryEventHandler(event)

Event handler for jQuery events triggered by a SideView or TwoSideView. These view classes expose methods to override event handling. Inside a handler passed to such methods, the this parameter refers to the view (SideView or TwoSideView).
Parameters:
Name Type Description
event jQuery event object
Source:

RulerSides

Flags controlling which rulers are visible and which are hidden.
Properties:
Name Type Attributes Default Description
top boolean <optional>
 false whether the top ruler is visible
bottom boolean <optional>
 false whether the bottom ruler is visible
left boolean <optional>
 false whether the left ruler is visible
right boolean <optional>
 false whether the right ruler is visible
Source:

SideViewData

The complete state of a SideView.
Properties:
Name Type Description
tag TagOptions tag options (as in setTag}
font module:TagPreview.Font font ID (as in setFont}
lines Array.<string> text lines
Source:

TagOptions

Options object passed to SideView#setTag and TwoSideView#setTag.
Properties:
Name Type Attributes Default Description
tagSku string tag SKU string in the extended format (e.g. "01-AU-DB-LG"); hyphens may be omitted (e.g. "01AUDBLG")
doubleSided boolean <optional>
 false allow engraving on both sides of the tag; note that the framework does not check if the tag is actually capable of double-side engraving
template string <optional>
 default template code
blankTagImageFileName string <optional>
 File name to use to display the blank tag image in preview mode. If not set, the main tag image is used as a fallback. If the file name has no extension, ".png" is assumed. The framework will automatically insert the right scale suffix in the file name before the extension if necessary to draw higher-resolution tag images.
Source:

TwoSideLines

Object describing text lines for both sides of a TwoSideView.
Properties:
Name Type Attributes Default Description
side1 Array.<string> text lines for side 1 (possibly an empty array)
side2 Array.<string> <optional>
 [] text lines for side 2 (possibly an empty array). Optional when passed to TwoSideView#setLines. Always returned by TwoSideView#getLines.
Source:

TwoSideViewData

The complete state of a TwoSideView.
Properties:
Name Type Description
tag TagOptions tag options (as in setTag}
font module:TagPreview.Font font ID (as in setFont}
side1 object side 1 state
Properties
Name Type Description
lines Array.<string> side 1 text lines
side2 object side 2 state
Properties
Name Type Description
lines Array.<string> side 2 text lines
Source:

UnitCorners

Flags controlling which corners display the measurement unit switcher.
Properties:
Name Type Attributes Default Description
topLeft boolean <optional>
 false whether units are visible in the top left corner
topRight boolean <optional>
 false whether units are visible in the top right corner
bottomLeft boolean <optional>
 false whether units are visible in the bottom left corner
bottomRight boolean <optional>
 false whether units are visible in the bottom right corner
Source: