## MaxiCodeParameters class

MaxiCode parameters.

```js
new MaxiCodeParameters()
```

## Methods

| Name | Description |
| --- | --- |
| [getAspectRatio()](#getaspectratio) | Height/Width ratio of 2D BarCode module. |
| [getECIEncoding()](#geteciencoding) | Gets ECI encoding. Used when MaxiCodeEncodeMode is AUTO. Default value: ISO-8859-1 |
| [getEncodeMode()](#getencodemode) | Gets a MaxiCode encode mode. Default value: Auto. |
| [getMaxiCodeEncodeMode()](#getmaxicodeencodemode) ~~(deprecated)~~ | Gets a MaxiCode encode mode. |
| [getMaxiCodeMode()](#getmaxicodemode) ~~(deprecated)~~ | Gets a MaxiCode encode mode. |
| [getMaxiCodeStructuredAppendModeBarcodeId()](#getmaxicodestructuredappendmodebarcodeid) ~~(deprecated)~~ | Gets a MaxiCode barcode id in structured append mode. ID must be a value between 1 and 8. Default value: 0 |
| [getMaxiCodeStructuredAppendModeBarcodesCount()](#getmaxicodestructuredappendmodebarcodescount) ~~(deprecated)~~ | Gets a MaxiCode barcodes count in structured append mode. Count number must be a value between 2 and 8 (maximum barcodes |
| [getMode()](#getmode) | Gets a MaxiCode encode mode. |
| [getStructuredAppendModeBarcodeId()](#getstructuredappendmodebarcodeid) | Gets a MaxiCode barcode id in structured append mode. ID must be a value between 1 and 8. Default value: 0 |
| [getStructuredAppendModeBarcodesCount()](#getstructuredappendmodebarcodescount) | Gets a MaxiCode barcodes count in structured append mode. Count number must be a value between 2 and 8 (maximum barcodes |
| [setAspectRatio()](#setaspectratio) | Height/Width ratio of 2D BarCode module. |
| [setECIEncoding()](#seteciencoding) | Sets ECI encoding. Used when MaxiCodeEncodeMode is AUTO. Default value: ISO-8859-1 |
| [setEncodeMode(value)](#setencodemode) | Sets a MaxiCode encode mode. Default value: Auto. |
| [setMaxiCodeEncodeMode()](#setmaxicodeencodemode) ~~(deprecated)~~ | Sets a MaxiCode encode mode. |
| [setMaxiCodeMode()](#setmaxicodemode) ~~(deprecated)~~ | Sets a MaxiCode encode mode. |
| [setMaxiCodeStructuredAppendModeBarcodeId()](#setmaxicodestructuredappendmodebarcodeid) ~~(deprecated)~~ | Sets a MaxiCode barcode id in structured append mode. ID must be a value between 1 and 8. Default value: 0 |
| [setMaxiCodeStructuredAppendModeBarcodesCount()](#setmaxicodestructuredappendmodebarcodescount) ~~(deprecated)~~ | Sets a MaxiCode barcodes count in structured append mode. Count number must be a value between 2 and 8 (maximum barcodes |
| [setMode(value)](#setmode) | Sets a MaxiCode encode mode. |
| [setStructuredAppendModeBarcodeId(value)](#setstructuredappendmodebarcodeid) | Sets a MaxiCode barcode id in structured append mode. ID must be a value between 1 and 8. Default value: 0 |
| [setStructuredAppendModeBarcodesCount(value)](#setstructuredappendmodebarcodescount) | Sets a MaxiCode barcodes count in structured append mode. Count number must be a value between 2 and 8 (maximum barcodes |
| [toString()](#tostring) | Returns a human-readable string representation of this MaxiCodeParameters. |

### getAspectRatio() {#getaspectratio}

Height/Width ratio of 2D BarCode module.

### getECIEncoding() {#geteciencoding}

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

### getEncodeMode() {#getencodemode}

Gets a MaxiCode encode mode. Default value: Auto.

**Returns:** a MaxiCode encode mode.

### getMaxiCodeEncodeMode() {#getmaxicodeencodemode}

> **Deprecated.** See method description for replacement.

Gets a MaxiCode encode mode.

### getMaxiCodeMode() {#getmaxicodemode}

> **Deprecated.** See method description for replacement.

Gets a MaxiCode encode mode.

### getMaxiCodeStructuredAppendModeBarcodeId() {#getmaxicodestructuredappendmodebarcodeid}

> **Deprecated.** See method description for replacement.

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

### getMaxiCodeStructuredAppendModeBarcodesCount() {#getmaxicodestructuredappendmodebarcodescount}

> **Deprecated.** See method description for replacement.

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

### getMode() {#getmode}

Gets a MaxiCode encode mode.

**Returns:** a MaxiCode encode mode.

### getStructuredAppendModeBarcodeId() {#getstructuredappendmodebarcodeid}

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

**Returns:** a MaxiCode barcode id in structured append mode.

### getStructuredAppendModeBarcodesCount() {#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:** a MaxiCode barcodes count in structured append mode.

### setAspectRatio() {#setaspectratio}

Height/Width ratio of 2D BarCode module.

### setECIEncoding() {#seteciencoding}

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

### setEncodeMode(value) {#setencodemode}

Sets a MaxiCode encode mode. Default value: Auto.

| Parameter | Description |
| --- | --- |
| value | a MaxiCode encode mode. |

### setMaxiCodeEncodeMode() {#setmaxicodeencodemode}

> **Deprecated.** See method description for replacement.

Sets a MaxiCode encode mode.

### setMaxiCodeMode() {#setmaxicodemode}

> **Deprecated.** See method description for replacement.

Sets a MaxiCode encode mode.

### setMaxiCodeStructuredAppendModeBarcodeId() {#setmaxicodestructuredappendmodebarcodeid}

> **Deprecated.** See method description for replacement.

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

### setMaxiCodeStructuredAppendModeBarcodesCount() {#setmaxicodestructuredappendmodebarcodescount}

> **Deprecated.** See method description for replacement.

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

### setMode(value) {#setmode}

Sets a MaxiCode encode mode.

| Parameter | Description |
| --- | --- |
| value | a MaxiCode encode mode. |

### setStructuredAppendModeBarcodeId(value) {#setstructuredappendmodebarcodeid}

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

| Parameter | Description |
| --- | --- |
| value | a MaxiCode barcode id in structured append mode. |

### setStructuredAppendModeBarcodesCount(value) {#setstructuredappendmodebarcodescount}

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

| Parameter | Description |
| --- | --- |
| value | a MaxiCode barcodes count in structured append mode. |

### toString() {#tostring}

Returns a human-readable string representation of this MaxiCodeParameters.

**Returns:** A string that represents this MaxiCodeParameters.