EncodeHintType

These are a set of hints that you may pass to Writers to specify their behavior.

Entries

Link copied to clipboard

Specifies what degree of error correction to use, for example in QR Codes. Type depends on the encoder. For example for QR codes it's type ErrorCorrectionLevel. For Aztec it is of type Integer, representing the minimal percentage of error correction words. For PDF417 it is of type Integer, valid values being 0 to 8. In all cases, it can also be a String representation of the desired value as well. Note: an Aztec symbol should have a minimum of 25% EC words.

Link copied to clipboard

Specifies what character encoding to use where applicable (type String)

Link copied to clipboard

Specifies the matrix shape for Data Matrix (type SymbolShapeHint)

Link copied to clipboard

Specifies whether to use compact mode for Data Matrix (type Boolean, or "true" or "false" String value). The compact encoding mode also supports the encoding of characters that are not in the ISO-8859-1 character set via ECIs. Please note that in that case, the most compact character encoding is chosen for characters in the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by means of the CHARACTER_SET encoding hint. Compact encoding also provides GS1-FNC1 support when GS1_FORMAT is selected. In this case group-separator character (ASCII 29 decimal) can be used to encode the positions of FNC1 codewords for the purpose of delimiting AIs. This option and FORCE_C40 are mutually exclusive.

Link copied to clipboard

Specifies a minimum barcode size (type Dimension). Only applicable to Data Matrix now.

Link copied to clipboard

Specifies a maximum barcode size (type Dimension). Only applicable to Data Matrix now.

Link copied to clipboard

Specifies margin, in pixels, to use when generating the barcode. The meaning can vary by format; for example it controls margin before and after the barcode horizontally for most 1D formats. (Type Integer, or String representation of the integer value).

Link copied to clipboard

Specifies whether to use compact mode for PDF417 (type Boolean, or "true" or "false" String value).

Link copied to clipboard

Specifies what compaction mode to use for PDF417 (type Compaction or String value of one of its enum values).

Link copied to clipboard

Specifies the minimum and maximum number of rows and columns for PDF417 (type Dimensions).

Link copied to clipboard

Specifies whether to automatically insert ECIs when encoding PDF417 (type Boolean, or "true" or "false" String value). Please note that in that case, the most compact character encoding is chosen for characters in the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by means of the CHARACTER_SET encoding hint.

Link copied to clipboard

Specifies the required number of layers for an Aztec code. A negative number (-1, -2, -3, -4) specifies a compact Aztec code. 0 indicates to use the minimum number of layers (the default). A positive number (1, 2, .. 32) specifies a normal (non-compact) Aztec code. (Type Integer, or String representation of the integer value).

Link copied to clipboard

Specifies the exact version of QR code to be encoded. (Type Integer, or String representation of the integer value).

Link copied to clipboard

Specifies the QR code mask pattern to be used. Allowed values are 0..QRCode.NUM_MASK_PATTERNS-1. By default the code will automatically select the optimal mask pattern. (Type Integer, or String representation of the integer value).

Link copied to clipboard

Specifies whether to use compact mode for QR code (type Boolean, or "true" or "false" String value). Please note that when compaction is performed, the most compact character encoding is chosen for characters in the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by means of the CHARACTER_SET encoding hint.

Link copied to clipboard

Specifies whether the data should be encoded to the GS1 standard (type Boolean, or "true" or "false" String value).

Link copied to clipboard

Forces which encoding will be used. Currently only used for Code-128 code sets (Type String). Valid values are "A", "B", "C". This option and CODE128_COMPACT are mutually exclusive.

Link copied to clipboard

Forces C40 encoding for data-matrix (type Boolean, or "true" or "false") String value). This option and DATA_MATRIX_COMPACT are mutually exclusive.

Link copied to clipboard

Specifies whether to use compact mode for Code-128 code (type Boolean, or "true" or "false" String value). This can yield slightly smaller bar codes. This option and FORCE_CODE_SET are mutually exclusive.

Properties

Link copied to clipboard

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Link copied to clipboard
expect val name: String
Link copied to clipboard
expect val ordinal: Int

Functions

Link copied to clipboard

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.