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

DataMatrix parameters. More...

Inherits _MwWrapper.

Public Member Functions

None __init__ (self, _java_class)
 
str __str__ (self)
 Returns a human-readable string representation of this DataMatrixParameters. More...
 
float aspect_ratio (self)
 Height/Width ratio of 2D BarCode module. More...
 
None aspect_ratio (self, float value)
 Height/Width ratio of 2D BarCode module. More...
 
int columns (self)
 Columns count. More...
 
None columns (self, int value)
 Columns count. More...
 
DataMatrixEccType data_matrix_ecc (self)
 Gets a Datamatrix ECC type. More...
 
None data_matrix_ecc (self, DataMatrixEccType value)
 Sets a Datamatrix ECC type. More...
 
DataMatrixEncodeMode data_matrix_encode_mode (self)
 Encode mode of Datamatrix barcode. More...
 
None data_matrix_encode_mode (self, DataMatrixEncodeMode value)
 Encode mode of Datamatrix barcode. More...
 
DataMatrixVersion data_matrix_version (self)
 Gets Datamatrix symbol size. More...
 
None data_matrix_version (self, DataMatrixVersion value)
 Sets Datamatrix symbol size. More...
 
DataMatrixEccType ecc_type (self)
 
None ecc_type (self, DataMatrixEccType value)
 
ECIEncodings eci_encoding (self)
 Gets ECI encoding. More...
 
None eci_encoding (self, ECIEncodings value)
 Sets ECI encoding. More...
 
DataMatrixEncodeMode encode_mode (self)
 
def encode_mode (self, DataMatrixEncodeMode value)
 
MacroCharacter macro_characters (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...
 
None macro_characters (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...
 
bool reader_programming (self)
 Used to instruct the reader to interpret the data contained within the symbol. More...
 
None reader_programming (self, bool value)
 Used to instruct the reader to interpret the data contained within the symbol. More...
 
int rows (self)
 Rows count. More...
 
None rows (self, int value)
 Rows count. More...
 
int structured_append_barcode_id (self)
 Barcode ID for Structured Append mode of Datamatrix barcode. More...
 
None structured_append_barcode_id (self, int value)
 Barcode ID for Structured Append mode of Datamatrix barcode. More...
 
int structured_append_barcodes_count (self)
 Barcodes count for Structured Append mode of Datamatrix barcode. More...
 
None structured_append_barcodes_count (self, int value)
 Barcodes count for Structured Append mode of Datamatrix barcode. More...
 
int structured_append_file_id (self)
 File ID for Structured Append mode of Datamatrix barcode. More...
 
None structured_append_file_id (self, int value)
 File ID for Structured Append mode of Datamatrix barcode. More...
 
DataMatrixVersion version (self)
 
def version (self, DataMatrixVersion value)
 

Detailed Description

DataMatrix parameters.

Constructor & Destructor Documentation

◆ __init__()

None __init__ (   self,
  _java_class 
)

Member Function Documentation

◆ __str__()

str __str__ (   self)

Returns a human-readable string representation of this DataMatrixParameters.

Returns
presentation of this DataMatrixParameters.

◆ aspect_ratio() [1/2]

float aspect_ratio (   self)

Height/Width ratio of 2D BarCode module.

◆ aspect_ratio() [2/2]

None aspect_ratio (   self,
float  value 
)

Height/Width ratio of 2D BarCode module.

◆ columns() [1/2]

int columns (   self)

Columns count.

◆ columns() [2/2]

None columns (   self,
int  value 
)

Columns count.

◆ data_matrix_ecc() [1/2]

DataMatrixEccType data_matrix_ecc (   self)

Gets a Datamatrix ECC type.

Default value: DataMatrixEccType.ECC_200.

◆ data_matrix_ecc() [2/2]

None data_matrix_ecc (   self,
DataMatrixEccType  value 
)

Sets a Datamatrix ECC type.

Default value: DataMatrixEccType.ECC_200.

◆ data_matrix_encode_mode() [1/2]

DataMatrixEncodeMode data_matrix_encode_mode (   self)

Encode mode of Datamatrix barcode.

Default value: DataMatrixEncodeMode.AUTO.

◆ data_matrix_encode_mode() [2/2]

None data_matrix_encode_mode (   self,
DataMatrixEncodeMode  value 
)

Encode mode of Datamatrix barcode.

Default value: DataMatrixEncodeMode.AUTO.

◆ data_matrix_version() [1/2]

DataMatrixVersion data_matrix_version (   self)

Gets Datamatrix symbol size.

Returns
Datamatrix symbol size.

◆ data_matrix_version() [2/2]

None data_matrix_version (   self,
DataMatrixVersion  value 
)

Sets Datamatrix symbol size.

Parameters
valueDatamatrix symbol size.

◆ ecc_type() [1/2]

DataMatrixEccType ecc_type (   self)
Gets a Datamatrix ECC type.
Default value: DataMatrixEccType.Ecc200.

:return: A Datamatrix ECC type.

◆ ecc_type() [2/2]

None ecc_type (   self,
DataMatrixEccType  value 
)
Sets a Datamatrix ECC type.
Default value: DataMatrixEccType.Ecc200.

:param value: A Datamatrix ECC type.

◆ eci_encoding() [1/2]

ECIEncodings eci_encoding (   self)

Gets ECI encoding.

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

◆ eci_encoding() [2/2]

None eci_encoding (   self,
ECIEncodings  value 
)

Sets ECI encoding.

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

◆ encode_mode() [1/2]

DataMatrixEncodeMode encode_mode (   self)
Encode mode of Datamatrix barcode.
Default value: EncodeMode.Auto.

◆ encode_mode() [2/2]

def encode_mode (   self,
DataMatrixEncodeMode  value 
)
Encode mode of Datamatrix barcode.
Default value: EncodeMode.Auto.

◆ macro_characters() [1/2]

MacroCharacter macro_characters (   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.

◆ macro_characters() [2/2]

None macro_characters (   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.

◆ reader_programming() [1/2]

bool reader_programming (   self)

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

◆ reader_programming() [2/2]

None reader_programming (   self,
bool  value 
)

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

◆ rows() [1/2]

int rows (   self)

Rows count.

◆ rows() [2/2]

None rows (   self,
int  value 
)

Rows count.

◆ structured_append_barcode_id() [1/2]

int structured_append_barcode_id (   self)

Barcode ID for Structured Append mode of Datamatrix barcode.

Default value: 0.

◆ structured_append_barcode_id() [2/2]

None structured_append_barcode_id (   self,
int  value 
)

Barcode ID for Structured Append mode of Datamatrix barcode.

Default value: 0.

◆ structured_append_barcodes_count() [1/2]

int structured_append_barcodes_count (   self)

Barcodes count for Structured Append mode of Datamatrix barcode.

Default value: 0.

◆ structured_append_barcodes_count() [2/2]

None structured_append_barcodes_count (   self,
int  value 
)

Barcodes count for Structured Append mode of Datamatrix barcode.

Default value: 0.

◆ structured_append_file_id() [1/2]

int structured_append_file_id (   self)

File ID for Structured Append mode of Datamatrix barcode.

Default value: 0.

◆ structured_append_file_id() [2/2]

None structured_append_file_id (   self,
int  value 
)

File ID for Structured Append mode of Datamatrix barcode.

Default value: 0.

◆ version() [1/2]

DataMatrixVersion version (   self)
Gets a Datamatrix symbol size.
Default value: Version.Auto.

:return: A Datamatrix symbol size.

◆ version() [2/2]

def version (   self,
DataMatrixVersion  value 
)
Sets a Datamatrix symbol size.
Default value: Version.Auto.

:param value: A Datamatrix symbol size.