Aspose.Barcode for Python via Java Generation and Recognition API docs
DataMatrixParameters Class Reference

DataMatrix parameters. More...

Inherits BaseJavaClass.

Public Member Functions

None __init__ (self, javaClass)
 
str __str__ (self)
 Returns a human-readable string representation of this DataMatrixParameters. More...
 
float getAspectRatio (self)
 Height/Width ratio of 2D BarCode module. More...
 
int getColumns (self)
 Columns count. More...
 
DataMatrixEccType getDataMatrixEcc (self)
 Gets a Datamatrix ECC type. More...
 
DataMatrixEncodeMode getDataMatrixEncodeMode (self)
 Encode mode of Datamatrix barcode. More...
 
DataMatrixVersion getDataMatrixVersion (self)
 Gets Datamatrix symbol size. More...
 
ECIEncodings getECIEncoding (self)
 Gets ECI encoding. More...
 
MacroCharacter getMacroCharacters (self)
 ISO/IEC 16022 5.2.4.7 Macro characters 11.3 Protocol for Macro characters in the first position (ECC 200 only) Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. More...
 
int getRows (self)
 Rows count. More...
 
int getStructuredAppendBarcodeId (self)
 Barcode ID for Structured Append mode of Datamatrix barcode. More...
 
int getStructuredAppendBarcodesCount (self)
 Barcodes count for Structured Append mode of Datamatrix barcode. More...
 
int getStructuredAppendFileId (self)
 File ID for Structured Append mode of Datamatrix barcode. More...
 
None init (self)
 
bool isReaderProgramming (self)
 Used to instruct the reader to interpret the data contained within the symbol. More...
 
None setAspectRatio (self, float value)
 Height/Width ratio of 2D BarCode module. More...
 
None setColumns (self, int value)
 Columns count. More...
 
None setDataMatrixEcc (self, DataMatrixEccType value)
 Sets a Datamatrix ECC type. More...
 
None setDataMatrixEncodeMode (self, DataMatrixEncodeMode value)
 Encode mode of Datamatrix barcode. More...
 
None setDataMatrixVersion (self, DataMatrixVersion value)
 Sets Datamatrix symbol size. More...
 
None setECIEncoding (self, ECIEncodings value)
 Sets ECI encoding. More...
 
None setMacroCharacters (self, MacroCharacter value)
 ISO/IEC 16022 5.2.4.7 Macro characters 11.3 Protocol for Macro characters in the first position (ECC 200 only) Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. More...
 
None setReaderProgramming (self, bool value)
 Used to instruct the reader to interpret the data contained within the symbol. More...
 
None setRows (self, int value)
 Rows count. More...
 
None setStructuredAppendBarcodeId (self, int value)
 Barcode ID for Structured Append mode of Datamatrix barcode. More...
 
None setStructuredAppendBarcodesCount (self, int value)
 Barcodes count for Structured Append mode of Datamatrix barcode. More...
 
None setStructuredAppendFileId (self, int value)
 File ID for Structured Append mode of Datamatrix barcode. More...
 
- Public Member Functions inherited from BaseJavaClass
def getJavaClass (self)
 
str getJavaClassName (self)
 
bool isNull (self)
 
None printJavaClassName (self)
 
None setJavaClass (self, javaClass)
 

Additional Inherited Members

- Public Attributes inherited from BaseJavaClass
 javaClass
 
 javaClassName
 

Detailed Description

DataMatrix parameters.

Constructor & Destructor Documentation

◆ __init__()

None __init__ (   self,
  javaClass 
)

Reimplemented from BaseJavaClass.

Member Function Documentation

◆ __str__()

str __str__ (   self)

Returns a human-readable string representation of this DataMatrixParameters.

Returns
presentation of this DataMatrixParameters.

◆ getAspectRatio()

float getAspectRatio (   self)

Height/Width ratio of 2D BarCode module.

◆ getColumns()

int getColumns (   self)

Columns count.

◆ getDataMatrixEcc()

DataMatrixEccType getDataMatrixEcc (   self)

Gets a Datamatrix ECC type.

Default value: DataMatrixEccType.ECC_200.

◆ getDataMatrixEncodeMode()

DataMatrixEncodeMode getDataMatrixEncodeMode (   self)

Encode mode of Datamatrix barcode.

Default value: DataMatrixEncodeMode.AUTO.

◆ getDataMatrixVersion()

DataMatrixVersion getDataMatrixVersion (   self)

Gets Datamatrix symbol size.

Returns
Datamatrix symbol size.

◆ getECIEncoding()

ECIEncodings getECIEncoding (   self)

Gets ECI encoding.

Used when DataMatrixEncodeMode is Auto. Default value: ISO-8859-1.

◆ getMacroCharacters()

MacroCharacter getMacroCharacters (   self)

ISO/IEC 16022 5.2.4.7 Macro characters 11.3 Protocol for Macro characters in the first position (ECC 200 only) Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes.

Can be used only with DataMatrixEccType.Ecc200 or DataMatrixEccType.EccAuto. Cannot be used with EncodeTypes.GS_1_DATA_MATRIX Default value: MacroCharacter.NONE.

◆ getRows()

int getRows (   self)

Rows count.

◆ getStructuredAppendBarcodeId()

int getStructuredAppendBarcodeId (   self)

Barcode ID for Structured Append mode of Datamatrix barcode.

Default value: 0.

◆ getStructuredAppendBarcodesCount()

int getStructuredAppendBarcodesCount (   self)

Barcodes count for Structured Append mode of Datamatrix barcode.

Default value: 0.

◆ getStructuredAppendFileId()

int getStructuredAppendFileId (   self)

File ID for Structured Append mode of Datamatrix barcode.

Default value: 0.

◆ init()

None init (   self)

Reimplemented from BaseJavaClass.

◆ isReaderProgramming()

bool isReaderProgramming (   self)

Used to instruct the reader to interpret the data contained within the symbol.

◆ setAspectRatio()

None setAspectRatio (   self,
float  value 
)

Height/Width ratio of 2D BarCode module.

◆ setColumns()

None setColumns (   self,
int  value 
)

Columns count.

◆ setDataMatrixEcc()

None setDataMatrixEcc (   self,
DataMatrixEccType  value 
)

Sets a Datamatrix ECC type.

Default value: DataMatrixEccType.ECC_200.

◆ setDataMatrixEncodeMode()

None setDataMatrixEncodeMode (   self,
DataMatrixEncodeMode  value 
)

Encode mode of Datamatrix barcode.

Default value: DataMatrixEncodeMode.AUTO.

◆ setDataMatrixVersion()

None setDataMatrixVersion (   self,
DataMatrixVersion  value 
)

Sets Datamatrix symbol size.

Parameters
valueDatamatrix symbol size.

◆ setECIEncoding()

None setECIEncoding (   self,
ECIEncodings  value 
)

Sets ECI encoding.

Used when DataMatrixEncodeMode is Auto. Default value: ISO-8859-1.

◆ setMacroCharacters()

None setMacroCharacters (   self,
MacroCharacter  value 
)

ISO/IEC 16022 5.2.4.7 Macro characters 11.3 Protocol for Macro characters in the first position (ECC 200 only) Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes.

Can be used only with DataMatrixEccType.Ecc200 or DataMatrixEccType.EccAuto. Cannot be used with EncodeTypes.GS_1_DATA_MATRIX Default value: MacroCharacter.NONE.

◆ setReaderProgramming()

None setReaderProgramming (   self,
bool  value 
)

Used to instruct the reader to interpret the data contained within the symbol.

◆ setRows()

None setRows (   self,
int  value 
)

Rows count.

◆ setStructuredAppendBarcodeId()

None setStructuredAppendBarcodeId (   self,
int  value 
)

Barcode ID for Structured Append mode of Datamatrix barcode.

Default value: 0.

◆ setStructuredAppendBarcodesCount()

None setStructuredAppendBarcodesCount (   self,
int  value 
)

Barcodes count for Structured Append mode of Datamatrix barcode.

Default value: 0.

◆ setStructuredAppendFileId()

None setStructuredAppendFileId (   self,
int  value 
)

File ID for Structured Append mode of Datamatrix barcode.

Default value: 0.