# Image Rendering Reference

## Navigation:

Index General Information Elements Utils Examples

# The <barcode> Element

## Description:

The barcode element defines the properties in order to output a barcode on the image.

### Multiple Occurrences allowed: true

## Attributes

Name | Description | Inheritated | Possible Values | Default Value | Examples
--- | --- | --- | --- | --- | ---
class | A identifier of a CSS class. This identifier can be referenced via a CSS file. The same class identifier is meant to be used in multiple tags | false | String | No default value | css1
id | A identifier of the tag. This identifier can be referenced via a CSS file. This identifier has to be unique | false | String | No default value | css1
type | The type of barcode that should be created | false | codabar | code128 | code39 | ean13 | ean8 | ean-128 | upc-a | upc-e | intl2of5 | itf-14 | postnet | royal-mail-cbc | usps4cb | pdf417 | datamatrix | qr | No default value | -

## Barcode Types

## codabar

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
fontSizePt | Specifies a set of font sizes separated by colon. The text will be rendered with the biggest possible (and specified) font size | A positive integer describing the font size in pt or multiple integers separated by a colon as alternative font seizes | 6
fontName | Defines the font of the text content of the barcode | A font name (e.g. Arial, Tahoma, Times New Roman, etc.) | helvetica
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 10
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | false
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
humanReadableEnabled | Enables or disables displaying the text content of the barcode | true|false | true
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
humanReadablePlacement | Defines where the text content should be displayed, relative to the barcode | bottom | top | none | bottom
displayStartStop | Enables/Disables display start and stop feature for codabar and code-39 barcodes | true|false | false

## code128

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
fontSizePt | Specifies a set of font sizes separated by colon. The text will be rendered with the biggest possible (and specified) font size | A positive integer describing the font size in pt or multiple integers separated by a colon as alternative font seizes | 6
fontName | Defines the font of the text content of the barcode | A font name (e.g. Arial, Tahoma, Times New Roman, etc.) | helvetica
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 10
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | false
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
humanReadableEnabled | Enables or disables displaying the text content of the barcode | true|false | true
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
humanReadablePlacement | Defines where the text content should be displayed, relative to the barcode | bottom | top | none | bottom
codesets | Sets the code set for code-128 barcodes | A string combination of A, B and C | abc

## code39

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
fontSizePt | Specifies a set of font sizes separated by colon. The text will be rendered with the biggest possible (and specified) font size | A positive integer describing the font size in pt or multiple integers separated by a colon as alternative font seizes | 6
fontName | Defines the font of the text content of the barcode | A font name (e.g. Arial, Tahoma, Times New Roman, etc.) | helvetica
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 10
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | false
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
humanReadableEnabled | Enables or disables displaying the text content of the barcode | true|false | true
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
humanReadablePlacement | Defines where the text content should be displayed, relative to the barcode | bottom | top | none | bottom
displayStartStop | Enables/Disables display start and stop feature for codabar and code-39 barcodes | true|false | false
displayChecksum | Shows/hides the checksum | true|false | false
checksumMode | Configures the handling of the checksum | add | check | ignore | auto | ignore
intercharGapWidth | Sets the gap width of the code-39 barcode | An non-negative integer value (>0) | 1
extendedCharset | Enables/disables extended charset for code-39 barcodes | true|false | false

## datamatrix

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 1
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | true
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
shape | Sets the shape of the data matrix | none|rectangle|shape | none
padded | Enables/disables padding | true|false | false
minSymbolSizeHeight | Sets the minimum symbol height | A positive integer value (>=0) | 1
minSymbolSizeWidth | Sets the minimum symbol width | A positive integer value (>=0) | 1
maxSymbolSizeHeight | Sets the maximum symbol height | A positive integer value (>=0) | 1
maxSymbolSizeWidth | Sets the maximum symbol width | A positive integer value (>=0) | 0

## ean-128

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
fontSizePt | Specifies a set of font sizes separated by colon. The text will be rendered with the biggest possible (and specified) font size | A positive integer describing the font size in pt or multiple integers separated by a colon as alternative font seizes | 6
fontName | Defines the font of the text content of the barcode | A font name (e.g. Arial, Tahoma, Times New Roman, etc.) | helvetica
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 10
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | false
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
humanReadableEnabled | Enables or disables displaying the text content of the barcode | true|false | true
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
humanReadablePlacement | Defines where the text content should be displayed, relative to the barcode | bottom | top | none | bottom
template | Sets an optional template for the ean-128 barcode | String | No default value
omitBrackets | Enables/Disables bracket omitting for ean-128 barcode | true|false | false

## ean13

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
fontSizePt | Specifies a set of font sizes separated by colon. The text will be rendered with the biggest possible (and specified) font size | A positive integer describing the font size in pt or multiple integers separated by a colon as alternative font seizes | 6
fontName | Defines the font of the text content of the barcode | A font name (e.g. Arial, Tahoma, Times New Roman, etc.) | helvetica
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 10
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | false
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
humanReadableEnabled | Enables or disables displaying the text content of the barcode | true|false | true
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
humanReadablePlacement | Defines where the text content should be displayed, relative to the barcode | bottom | top | none | bottom
checksumMode | Configures the handling of the checksum | add | check | ignore | auto | auto

## ean8

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
fontSizePt | Specifies a set of font sizes separated by colon. The text will be rendered with the biggest possible (and specified) font size | A positive integer describing the font size in pt or multiple integers separated by a colon as alternative font seizes | 6
fontName | Defines the font of the text content of the barcode | A font name (e.g. Arial, Tahoma, Times New Roman, etc.) | helvetica
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 10
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | false
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
humanReadableEnabled | Enables or disables displaying the text content of the barcode | true|false | true
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
humanReadablePlacement | Defines where the text content should be displayed, relative to the barcode | bottom | top | none | bottom
checksumMode | Configures the handling of the checksum | add | check | ignore | auto | auto

## intl2of5

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
fontSizePt | Specifies a set of font sizes separated by colon. The text will be rendered with the biggest possible (and specified) font size | A positive integer describing the font size in pt or multiple integers separated by a colon as alternative font seizes | 6
fontName | Defines the font of the text content of the barcode | A font name (e.g. Arial, Tahoma, Times New Roman, etc.) | helvetica
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 10
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | false
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
humanReadableEnabled | Enables or disables displaying the text content of the barcode | true|false | true
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
humanReadablePlacement | Defines where the text content should be displayed, relative to the barcode | bottom | top | none | bottom
wideFactor | Specifies the factor that is used to calculate the space between the barcode stripes | A positive float number (>0) | 3.0
checksumMode | Configures the handling of the checksum | add | check | ignore | auto | ignore
displayChecksum | Shows/hides the checksum | true|false | false

## itf-14

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
fontSizePt | Specifies a set of font sizes separated by colon. The text will be rendered with the biggest possible (and specified) font size | A positive integer describing the font size in pt or multiple integers separated by a colon as alternative font seizes | 6
fontName | Defines the font of the text content of the barcode | A font name (e.g. Arial, Tahoma, Times New Roman, etc.) | helvetica
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 10
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | false
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
humanReadableEnabled | Enables or disables displaying the text content of the barcode | true|false | true
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
humanReadablePlacement | Defines where the text content should be displayed, relative to the barcode | bottom | top | none | bottom
bearerBarWidth | Specifies the bearer box width (border) for itf-14 barcodes in pixels | A positive integer value (>=0) | 20
bearerBox | Specifies the bearer box width (border) for itf-14 barcodes in pixels | A positive integer value (>=0) | true
wideFactor | Specifies the factor that is used to calculate the space between the barcode stripes | A positive float number (>0) | 2.0
checksumMode | Configures the handling of the checksum | add | check | ignore | auto | auto
displayChecksum | Shows/hides the checksum | true|false | false

## pdf417

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
fontSizePt | Specifies a set of font sizes separated by colon. The text will be rendered with the biggest possible (and specified) font size | A positive integer describing the font size in pt or multiple integers separated by a colon as alternative font seizes | 6
fontName | Defines the font of the text content of the barcode | A font name (e.g. Arial, Tahoma, Times New Roman, etc.) | helvetica
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
humanReadableEnabled | Enables or disables displaying the text content of the barcode | true|false | true
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
humanReadablePlacement | Defines where the text content should be displayed, relative to the barcode | bottom | top | none | bottom
rowHeightRatio | Specifies the row height ratio for the pdf417 barcode | A positive float number (>0) | 3.0
columns | Specifies the number of columns. Can be disabled using a zero value, in this case it is automatically detected | An non-negative integer value (>0) | 0
minColumns | Specifies the minimum number of columns | An non-negative integer value (>0) | 2
maxColumns | Specifies the maximum number of columns | An non-negative integer value (>0) | 2
ecLevel | Specifies the minimum number of rows | An non-negative integer value (>0) | 0
widthToHeightRatio | Specifies the ratio between width and height | A positive float number (>0) | 3.0
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 2
verticalQuietZoneFactor | Factor for calculating vertical quiet zone | An non-negative integer value (>0) | 6
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | true
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
padded | Enables/disables padding | true|false | false
minRows | Specifies the minimum number of rows | An non-negative integer value (>0) | 3
maxRows | Specifies the minimum number of rows | An non-negative integer value (>0) | 90
autoMode | Enables/disables auto mode of pdf-417 barcodes | true|false | true

## postnet

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
fontSizePt | Specifies a set of font sizes separated by colon. The text will be rendered with the biggest possible (and specified) font size | A positive integer describing the font size in pt or multiple integers separated by a colon as alternative font seizes | 6
fontName | Defines the font of the text content of the barcode | A font name (e.g. Arial, Tahoma, Times New Roman, etc.) | helvetica
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 10
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | false
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
humanReadableEnabled | Enables or disables displaying the text content of the barcode | true|false | true
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
humanReadablePlacement | Defines where the text content should be displayed, relative to the barcode | bottom | top | none | bottom

## qr

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
padded | Enables/disables padding | true|false | false
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 2
errorCorrectionLevel | Specifies the error correction level of the QR tag | l | m | q | h | h
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false

## royal-mail-cbc

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
fontSizePt | Specifies a set of font sizes separated by colon. The text will be rendered with the biggest possible (and specified) font size | A positive integer describing the font size in pt or multiple integers separated by a colon as alternative font seizes | 6
fontName | Defines the font of the text content of the barcode | A font name (e.g. Arial, Tahoma, Times New Roman, etc.) | helvetica
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 10
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | false
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
humanReadableEnabled | Enables or disables displaying the text content of the barcode | true|false | true
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
humanReadablePlacement | Defines where the text content should be displayed, relative to the barcode | bottom | top | none | bottom

## upc-a

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
fontSizePt | Specifies a set of font sizes separated by colon. The text will be rendered with the biggest possible (and specified) font size | A positive integer describing the font size in pt or multiple integers separated by a colon as alternative font seizes | 6
fontName | Defines the font of the text content of the barcode | A font name (e.g. Arial, Tahoma, Times New Roman, etc.) | helvetica
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 10
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | false
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
humanReadableEnabled | Enables or disables displaying the text content of the barcode | true|false | true
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
humanReadablePlacement | Defines where the text content should be displayed, relative to the barcode | bottom | top | none | bottom
checksumMode | Configures the handling of the checksum | add | check | ignore | auto | auto

## upc-e

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
fontSizePt | Specifies a set of font sizes separated by colon. The text will be rendered with the biggest possible (and specified) font size | A positive integer describing the font size in pt or multiple integers separated by a colon as alternative font seizes | 6
fontName | Defines the font of the text content of the barcode | A font name (e.g. Arial, Tahoma, Times New Roman, etc.) | helvetica
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 10
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | false
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
humanReadableEnabled | Enables or disables displaying the text content of the barcode | true|false | true
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
humanReadablePlacement | Defines where the text content should be displayed, relative to the barcode | bottom | top | none | bottom
checksumMode | Configures the handling of the checksum | add | check | ignore | auto | auto

## usps4cb

Name | Description | Possible Values | Default Value
--- | --- | --- | ---
fontSizePt | Specifies a set of font sizes separated by colon. The text will be rendered with the biggest possible (and specified) font size | A positive integer describing the font size in pt or multiple integers separated by a colon as alternative font seizes | 6
fontName | Defines the font of the text content of the barcode | A font name (e.g. Arial, Tahoma, Times New Roman, etc.) | helvetica
quietZoneFactor | Factor for calculating the barcode's quiet zone | An non-negative integer value (>0) | 10
quietZoneEnabled | Whether quiet zone should be en/disabled | true|false | false
scale | Sets the scale for the barcode itself | A positive integer value (>=0) | 1
humanReadableEnabled | Enables or disables displaying the text content of the barcode | true|false | true
autoscale | Enables/disables to automatically scale the element. The element will scaled to the size of the field | true|false | false
humanReadablePlacement | Defines where the text content should be displayed, relative to the barcode | bottom | top | none | bottom

## Child Elements

#text

## Examples

- Barcode Example