MaxiCodeParameters

MaxiCodeParameters

MaxiCode parameters.

Constructor

new MaxiCodeParameters()

Source:

Methods

getAspectRatio()

Height/Width ratio of 2D BarCode module.
Source:

getECIEncoding()

Gets ECI encoding. Used when MaxiCodeEncodeMode is AUTO. Default value: ISO-8859-1
Source:

getEncodeMode()

Gets a MaxiCode encode mode. Default value: Auto.

Returns:
Type Description
a MaxiCode encode mode.
Source:

getMaxiCodeEncodeMode()

Gets a MaxiCode encode mode.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getEncodeMode().

Source:

getMaxiCodeMode()

Gets a MaxiCode encode mode.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getMode().

Source:

getMaxiCodeStructuredAppendModeBarcodeId()

Gets a MaxiCode barcode id in structured append mode.
ID must be a value between 1 and 8.
Default value: 0
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getStructuredAppendModeBarcodeId().

Source:

getMaxiCodeStructuredAppendModeBarcodesCount()

Gets a MaxiCode barcodes count in structured append mode.
Count number must be a value between 2 and 8 (maximum barcodes count).
Default value: -1
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getStructuredAppendModeBarcodesCount().

Source:

getMode()

Gets a MaxiCode encode mode.

Returns:
Type Description
a MaxiCode encode mode.
Source:

getStructuredAppendModeBarcodeId()

Gets a MaxiCode barcode id in structured append mode. ID must be a value between 1 and 8. Default value: 0

Returns:
Type Description
a MaxiCode barcode id in structured append mode.
Source:

getStructuredAppendModeBarcodesCount()

Gets a MaxiCode barcodes count in structured append mode. Count number must be a value between 2 and 8 (maximum barcodes count). Default value: -1

Returns:
Type Description
a MaxiCode barcodes count in structured append mode.
Source:

setAspectRatio()

Height/Width ratio of 2D BarCode module.
Source:

setECIEncoding()

Sets ECI encoding. Used when MaxiCodeEncodeMode is AUTO.
Default value: ISO-8859-1
Source:

setEncodeMode(value)

Sets a MaxiCode encode mode. Default value: Auto.

Parameters:
Name Type Description
value a MaxiCode encode mode.
Source:

setMaxiCodeEncodeMode()

Sets a MaxiCode encode mode.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setEncodeMode().

Source:

setMaxiCodeMode()

Sets a MaxiCode encode mode.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setMode().

Source:

setMaxiCodeStructuredAppendModeBarcodeId()

Sets a MaxiCode barcode id in structured append mode.
ID must be a value between 1 and 8.
Default value: 0
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setStructuredAppendModeBarcodeId().

Source:

setMaxiCodeStructuredAppendModeBarcodesCount()

Sets a MaxiCode barcodes count in structured append mode.
Count number must be a value between 2 and 8 (maximum barcodes count).
Default value: -1
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setStructuredAppendModeBarcodesCount().

Source:

setMode(value)

Sets a MaxiCode encode mode.

Parameters:
Name Type Description
value a MaxiCode encode mode.
Source:

setStructuredAppendModeBarcodeId(value)

Sets a MaxiCode barcode id in structured append mode. ID must be a value between 1 and 8. Default value: 0

Parameters:
Name Type Description
value a MaxiCode barcode id in structured append mode.
Source:

setStructuredAppendModeBarcodesCount(value)

Sets a MaxiCode barcodes count in structured append mode. Count number must be a value between 2 and 8 (maximum barcodes count). Default value: -1

Parameters:
Name Type Description
value a MaxiCode barcodes count in structured append mode.
Source:

toString()

Returns a human-readable string representation of this MaxiCodeParameters.
Returns:
Type Description
A string that represents this MaxiCodeParameters.
Source: