Container Path: <cwt><TICKET><barcodes>
Element Path: <cwt><TICKET><barcodes><barcode2D>
The barcode2D sub-element defines the layout of a 2D barcode. Several 1D and 2D barcode layouts can be defined at the same time for a ticket.
The following Example: shows a ticket with two possible 2D barcode layouts. The @I command in the ticket layout references the 2D barcode layout via the id attribute in the barcode2D element. The ticket below will use the barcode2D element with id =”1” and the resulting barcode will contain the text “Expiry date:” and the value of the expiry date in the form of year, month and day. Note that only variables like the @v0 command) and text can be entered in the code attribute of the barcode2D element.
attributes
aztecCodeErrorCorrection
| Value: | 0–4294967295 |
| Default: | 23 |
| Description: | Error Correction Percentage to apply for Aztec Code symbology |
aztecCodeFormat
| Value: | 0–4294967295 |
| Default: | 1 |
| Description: | 0 = Auto |
1 = C15X15Compact |
19 = C79X79 |
2 = C19X19 |
20 = C83X83 |
3 = C19X19Compact |
21 = C87X87 |
4 = C23X23 |
22 = C91X91 |
5 = C23X23Compact |
23 = C95X95 |
6 = C27X27 |
24 = C101X101 |
7 = C27X27Compact |
25 = C105X105 |
8 = C31X31 |
26 = C109X109 |
9 = C37X37 |
27 = C113X113 |
10 = C41X41 |
28 = C117X117 |
11 = C45X45 |
29 = C121X121 |
12 = C49X49 |
30 = C125X125 |
13 = C53X53 |
31 = C131X131 |
14 = C57X57 |
32 = C135X135 |
15 = C61X61 |
33 = C139X139 |
16 = C67X67 |
34 = C143X143 |
17 = C71X71 |
35 = C147X147 |
18 = C75X75 |
36 = C151X151 |
aztecCodeModuleSize
| Value: | -3.4028235e+038 - 3.4028235e+038 |
| Default: | 0.07 |
| Description: | Aztec module size. It is measured in inches. |
aztecCodeRune
| Value: | -1–255 |
| Default: | -1 |
| Description: | Aztec Code Rune value. It must be a value from -1 to 255 and is available for Aztec Code Compact Format only. |
| -1 = No rune |
barHeight
| Value: | -3.4028235e+038 - 3.4028235e+038 |
| Default: | 0,75 |
| Description: | Sets the bars' height of the barcode. It is measured in inches. |
barRatio
| Value: | 0–4294967295 |
| Default: | 2 |
| Description: | Sets the wide bars' width compared to the narrow bars' width. In barcode terminology, this is N value. |
barWidth
| Value: | -3.4028235e+038 - 3.4028235e+038 |
| Default: | 0,035 |
| Description: | Sets the narrow bars width of the barcode. In barcode terminology this is X value. It is measured in inches. |
borderWidth
| Value: | 0–4294967295 |
| Default: | 0 |
| Description: | Barcode image border width. |
bottomMargin
| Value: | -3.4028235e+038 - 3.4028235e+038 |
| Default: | 0.0 |
| Description: | Height of the margin below the barcode bars. It's measured in inches |
code
| Value: | Any characters |
| Default: | - |
| Description: | Sets the value to encode. |
code16kMode
| Value: | 0–2 |
| Default: | 0 |
| Description: | 0 = Mode 0 (ASCII 0 - 97) 1 = Mode 1 (ASCII 32 – 127) 2 = Mode 2 (Pairs of digits) |
dataMatrixEncoding
| Value: | 0–4 |
| Default: | 0 |
| Description: | 0 = Auto 1 = Ascii 2 = C40 3 = Text 4 = Base256 |
dataMatrixFormat
| Value: | 0–30 |
| Default: | 0 |
| Description: | 0 = Auto |
1 = C10X10 |
16 = C64X64 |
2 = C12X12 |
17 = C72X72 |
3 = C14X14 |
18 = C80X80 |
4 = C16X16 |
19 = C88X88 |
5 = C18X18 |
20 = C96X96 |
6 = C20X20 |
21 = C104X104 |
7 = C22X22 |
22 = C120X120 |
8 = C24X24 |
23 = C132X132 |
9 = C26X26 |
24 = C144X144 |
10 = C32X32 |
25 = C8X18 |
11 = C36X36 |
26 = C8X32 |
12 = C40X40 |
27 = C12X26 |
13 = C44X44 |
28 = C12X36 |
14 = C48X48 |
29 = C16X36 |
15 = C52X52 |
30 = X16X48 |
dataMatrixModuleSize
| Value: | -3.4028235e+038 - 3.4028235e+038 |
| Default: | 0.5 |
| Description: | Barcode module size. It is measured in inches. |
dataMatrixProcessTilde
| Value: | true/false |
| Default: | true |
| Description: | True if tilde character should be processed when DataMatrix code is being generated. |
Id
| Value: | 0–65535 |
| Default: | - |
| Description: | The id of the barcode layout. Must be unique within the ticket definition. |
microPdf417Version
| Value: | 0-34 |
| Default: | 0 |
| Description: | MicroPDF417 version (a predefined combination of numbers of columns and rows) to be generated. |
0 = Auto |
17 = V3X12 |
1 = V1X11 |
18 = V3X15 |
2 = V1X14 |
19 = V3X20 |
3 = V1X17 |
20 = V3X26 |
4 = V1X20 |
21 = V3X32 |
5 = V1X24 |
22 = V3X38 |
6 = V1X28 |
23 = V3X44 |
7 = V2X8 |
24 = V4X4 |
8 = V2X11 |
25 = V4X6 |
9 = V2X14 |
26 = V4X8 |
10 = V2X17 |
27 = V4X10 |
11 = V2X20 |
28 = V4X12 |
12 = V2X23 |
29 = V4X15 |
13 = V2X26 |
30 = V4X201 = V4X26 |
14 = V3X6 |
32 = V4X32 |
15 = V3X8 |
33 = V4X38 |
16 = V3X10 |
34 = V4X44 |
pdf417AspectRatio
| Value: | -3.4028235e+038 - 3.4028235e+038 |
| Default: | 1.0 |
| Description: | Ratio of the height to the overall width of the PDF417 symbol. Its value must be 0 (zero) up to 1 (one). |
pdf417Columns
| Value: | 0–4294967295 |
| Default: | 2 |
| Description: | Number of columns to use for PDF417 symbology. |
pdf417CompactionType
| Value: | 0–3 |
| Default: | 0 |
| Description: | 0 = Auto It switches between Text, Binary and Numeric modes in order to minimize the number of code words to be encoded. |
| 1 = Binary It allows encoding all 256 possible 8-bit byte values. This includes all ASCII characters values from 0 to 127 inclusive and provides for international character set support. |
| 2 = Text It allows encoding all printable ASCII characters, i.e. values from 32 to 126 inclusive in accordance with ISO/IEC 646, as well as selected control characters such as TAB (horizontal tab ASCII 9), LF (NL line feed, new line ASCII 10) and CR (carriage return ASCII 13). |
| 3 = Numeric It allows encoding numeric data strings. |
pdf417ErrorCorrectionLevel
| Value: | 0–8 |
| Default: | 0 |
| Description: | 0 = Level 0 to 8 = Level 8 |
pdf417Rows
| Value: | 0–4294967295 |
| Default: | 2 |
| Description: | Number of rows to use for PDF417 symbology. |
pdf417SegmentCount
| Value: | 0–4294967295 |
| Default: | 999999 |
| Description: | Number of Macro PDF417 symbols. The value must be less than or equal to 99999. |
pdf417SegmentIndex
| Value: | 0–4294967295 |
| Default: | 0 |
| Description: | Segment Index for a Macro PDF417 symbol. Its value must be 0 (zero) up to 99998 and must be less than the value in Pdf417SegmentCount property. |
pdf417Truncated
| Value: | true/false |
| Default: | false |
| Description: | Sets whether the right side of PDF417 barcode is truncated (removed). |
qRCodeEncoding
| Value: | 0-4 |
| Default: | 0 |
| Description: | 0 = Auto |
| 1 = Numeric Used to encode data that mainly contains numeric characters. |
| 2 = Alpha Numeric Used to encode data that mainly contains alphanumeric characters. |
| 3 = Kanji Used to encode data that mainly contains Kanji characters. |
| 4 = Byte Used to encode 8-bit values. |
qRCodeErrorCorrectionLevel
| Value: | 0-3 |
| Default: | 0 |
| Description: | 0 = Approx. 7% of code words can be restored. Error correction level L is appropriate for high symbol quality and/or the need for the smallest possible symbol. |
| 1= Approx. 15% of code words can be restored. Level M is described as Standard level and offers a good compromise between small size and increased reliability. |
| 2= Approx. 25% of code words can be restored. Level Q is a High reliability level and suitable for more critical or poor print quality applications |
| 3= Approx. 30% of code words can be restored. Level H offers the maximum achievable reliability. |
qRCodeModuleSize
| Value: | -3.4028235e+038 - 3.4028235e+038 |
| Default: | 1.0 |
| Description: | Barcode module size. It is measured in inches. |
qRCodeVersion
| Value: | 0-40 |
| Default: | 0 |
| Description: | 0 = Auto 1 = V01 to 40 = V40 |
quietZoneWidth
| Value: | -3.4028235e+038 - 3.4028235e+038 |
| Default: | 0.15 |
| Description: | Sets the quiet zone's width. It is measured in inches. |
symbology
| Value: | 0-8 |
| Default: | 5 |
| Description: |
Id |
Name |
Description |
|---|---|---|
0 |
Code16k |
Code 16K |
1 |
Data Matrix |
Data Matrix a.k.a. Data Matrix ECC200 |
2 |
Pdf417 |
PDF417 a.k.a. Portable Data File 417, PDF 417, PDF417 Truncated |
3 |
QRCode |
QR Code a.k.a. Quick Response Code, QRCode Model 2, JIS X 0510, ISO-IEC 18004 |
4 |
Semacode |
Semacode a.k.a. URL Barcode, Semacode Tag |
5 |
Aztec Code |
Aztec Code a.k.a. AIM Aztec Barcode, ANSI/AIM BC13 ITS/97/002 |
6 |
Compact Pdf417 |
Compact PDF417 a.k.a. Compact Portable Data File 417, Compact PDF 417, PDF417 Truncated |
7 |
Macro Pdf417 |
Macro PDF417 a.k.a. Macro Portable Data File 417, Macro PDF 417, MacroPDF417 |
8 |
Micro Pdf417 |
Micro PDF417 a.k.a. Micro Portable Data File 417, Micro PDF 417, MicroPDF417 |
text
| Value: | Any characters |
| Default: | - |
| Description: | Sets the additional text to show in the barcode image. Note: This is not the value to encode. |
textAlignment
| Value: | 0 (Above Center) 1 (Above Left) 2 (Above Right) 3 (Below Center) 4 (Below Left) 5 (Below Right) |
| Default: | 0 |
| Description: | Sets the text alignment for text property. |
topMargin
| Value: | -3.4028235e+038 - 3.4028235e+038 |
| Default: | 0.0 |
| Description: | Sets the height of the margin above the barcode bars. It's measured in inches. |
Example:
<TICKET ticketId="0" height="300" width="380" orientation="Landscape" layout="Paid amount: @v0 @I1">
<margin left="25" right="0" top="0" bottom="0"/>
<barcodes>
<barcode2D id=“0” code=”@v466@v467” />
<barcode2D id=”1” code=”Expiry date: @v113@v14@v15” />
</barcodes>
</TICKET>
