QrParameters

QrParameters class

Module: aspose_barcode.generation.qr_parameters

QR parameters.

Constructors

NameDescription
init

Methods

NameReturn TypeStaticDescription
strstrNoReturns a human-readable string representation of this QrParameters.

Properties

NameTypeDescription
aspect_ratiofloatHeight/Width ratio of 2D BarCode module.
eci_encodingECIEncodings
encode_GS_1_separator_in_byte_modeboolGets a value indicating whether GS1 special characters should be encoded in Byte mode for QR and RectMicroQR barcodes. If False, GS1 separators may be encoded as ’’ in Alphanumeric mode according to the QR specification. If True, GS1 group separators are encoded in Byte mode as the 0x1D character, and ’’ characters are also encoded in Byte mode to preserve them as data. This option may improve compatibility with decoders that expect byte-level GS1 group separators and prevents ’’ data characters from being interpreted as GS1 separators. Returns: bool: True if GS1 special characters should be encoded in Byte mode for QR and RectMicroQR barcodes; otherwise, False.
encode_modeQREncodeMode
error_levelQRErrorLevel
micro_qr_versionMicroQRVersionVersion of MicroQR Code.
qr_eci_encodingECIEncodingsExtended Channel Interpretation Identifiers.
qr_encode_modeQREncodeModeQR symbology type of BarCode’s encoding mode.
qr_encode_typeQREncodeTypeQR / MicroQR selector mode. Select ForceQR for standard QR symbols, Auto for MicroQR.
qr_error_levelQRErrorLevelLevel of Reed-Solomon error correction for QR barcode. From low to high: LEVEL_L, LEVEL_M, LEVEL_Q, LEVEL_H. see QRErrorLevel.
qr_versionQRVersionVersion of QR Code. From Version1 to Version40 for QR code and from M1 to M4 for MicroQr. Default value is QRVersion.AUTO.
rect_micro_qr_versionRectMicroQRVersionVersion of RectMicroQR Code.
structured_appendOptional[QrStructuredAppendParameters]QR structured append parameters.
versionQRVersion

QrParameters Constructor

__init__(self, _java_class)
ParameterTypeDescription
_java_class``

QrParameters.str

__str__(self) -> str

Returns a human-readable string representation of this QrParameters.

Return Type: str — A string that represents this QrParameters.

QrParameters.aspect_ratio

Type: float

Height/Width ratio of 2D BarCode module.

Height/Width ratio of 2D BarCode module.

ParameterTypeDescription
valuefloat

QrParameters.eci_encoding

Type: ECIEncodings

ParameterTypeDescription
valueECIEncodings

QrParameters.encode_GS_1_separator_in_byte_mode

Type: bool

Gets a value indicating whether GS1 special characters should be encoded in Byte mode for QR and RectMicroQR barcodes. If False, GS1 separators may be encoded as ’’ in Alphanumeric mode according to the QR specification. If True, GS1 group separators are encoded in Byte mode as the 0x1D character, and ’’ characters are also encoded in Byte mode to preserve them as data. This option may improve compatibility with decoders that expect byte-level GS1 group separators and prevents ’’ data characters from being interpreted as GS1 separators. Returns: bool: True if GS1 special characters should be encoded in Byte mode for QR and RectMicroQR barcodes; otherwise, False.

Sets a value indicating whether GS1 special characters should be encoded in Byte mode for QR and RectMicroQR barcodes. If False, GS1 separators may be encoded as ’’ in Alphanumeric mode according to the QR specification. If True, GS1 group separators are encoded in Byte mode as the 0x1D character, and ’’ characters are also encoded in Byte mode to preserve them as data. This option may improve compatibility with decoders that expect byte-level GS1 group separators and prevents ’’ data characters from being interpreted as GS1 separators. Args: value: True if GS1 special characters should be encoded in Byte mode for QR and RectMicroQR barcodes; otherwise, False.

ParameterTypeDescription
valuebool

QrParameters.encode_mode

Type: QREncodeMode

ParameterTypeDescription
valueQREncodeMode

QrParameters.error_level

Type: QRErrorLevel

ParameterTypeDescription
valueQRErrorLevel

QrParameters.micro_qr_version

Type: MicroQRVersion

Version of MicroQR Code.

Version of MicroQR Code.

ParameterTypeDescription
valueMicroQRVersion

QrParameters.qr_eci_encoding

Type: ECIEncodings

Extended Channel Interpretation Identifiers.

Extended Channel Interpretation Identifiers.

ParameterTypeDescription
valueECIEncodings

QrParameters.qr_encode_mode

Type: QREncodeMode

QR symbology type of BarCode’s encoding mode.

QR symbology type of BarCode’s encoding mode.

ParameterTypeDescription
valueQREncodeMode

QrParameters.qr_encode_type

Type: QREncodeType

QR / MicroQR selector mode. Select ForceQR for standard QR symbols, Auto for MicroQR.

QR / MicroQR selector mode.

ParameterTypeDescription
valueQREncodeType

QrParameters.qr_error_level

Type: QRErrorLevel

Level of Reed-Solomon error correction for QR barcode. From low to high: LEVEL_L, LEVEL_M, LEVEL_Q, LEVEL_H. see QRErrorLevel.

Level of Reed-Solomon error correction for QR barcode. From low to high: LEVEL_L, LEVEL_M, LEVEL_Q, LEVEL_H. see QRErrorLevel.

ParameterTypeDescription
valueQRErrorLevel

QrParameters.qr_version

Type: QRVersion

Version of QR Code. From Version1 to Version40 for QR code and from M1 to M4 for MicroQr. Default value is QRVersion.AUTO.

Version of QR Code. From Version1 to Version40 for QR code and from M1 to M4 for MicroQr. Default value is QRVersion.AUTO.

ParameterTypeDescription
valueQRVersion

QrParameters.rect_micro_qr_version

Type: RectMicroQRVersion

Version of RectMicroQR Code.

Version of RectMicroQR Code.

ParameterTypeDescription
valueRectMicroQRVersion

QrParameters.structured_append

Type: Optional[QrStructuredAppendParameters]

QR structured append parameters.

QR structured append parameters.

ParameterTypeDescription
valueQrStructuredAppendParameters

QrParameters.version

Type: QRVersion

ParameterTypeDescription
valueQRVersion