
## AztecParameters class

Aztec parameters.

```js
new AztecParameters()
```

## Methods

| Name | Description |
| --- | --- |
| [getAspectRatio()](#getaspectratio) | Height/Width ratio of 2D BarCode module. |
| [getAztecEncodeMode()](#getaztecencodemode) ~~(deprecated)~~ | Gets a Aztec encode mode. Default value: Auto. |
| [getAztecErrorLevel()](#getaztecerrorlevel) ~~(deprecated)~~ | Level of error correction of Aztec types of barcode. Value should between 5 to 95. |
| [getAztecSymbolMode()](#getaztecsymbolmode) ~~(deprecated)~~ | Gets a Aztec Symbol mode. Default value: AztecSymbolMode.Auto. |
| [getECIEncoding()](#geteciencoding) | Gets ECI encoding. Used when AztecEncodeMode is Auto. Default value: ISO-8859-1 |
| [getEncodeMode()](#getencodemode) | Gets a Aztec encode mode. Default value: Auto. |
| [getErrorLevel()](#geterrorlevel) | Level of error correction of Aztec types of barcode. Value should between 5 to 95. |
| [getLayersCount()](#getlayerscount) | Gets layers count of Aztec symbol. Layers count should be in range from 1 to 3 for Compact mode and in range from 1 to 3 |
| [getStructuredAppendBarcodeId()](#getstructuredappendbarcodeid) | Barcode ID for Structured Append mode of Aztec barcode. Barcode ID should be in range from 1 to barcodes count. Default  |
| [getStructuredAppendBarcodesCount()](#getstructuredappendbarcodescount) | Barcodes count for Structured Append mode of Aztec barcode. Barcodes count should be in range from 1 to 26. Default valu |
| [getStructuredAppendFileId()](#getstructuredappendfileid) | File ID for Structured Append mode of Aztec barcode (optional field). File ID should not contain spaces. Default value:  |
| [getSymbolMode()](#getsymbolmode) | Gets a Aztec Symbol mode. Default value: AztecSymbolMode.Auto. |
| [isReaderInitialization()](#isreaderinitialization) | Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization. |
| [setAspectRatio()](#setaspectratio) | Height/Width ratio of 2D BarCode module. |
| [setAztecEncodeMode()](#setaztecencodemode) ~~(deprecated)~~ | Sets a Aztec encode mode. Default value: Auto. |
| [setAztecErrorLevel()](#setaztecerrorlevel) ~~(deprecated)~~ | Level of error correction of Aztec types of barcode. Value should between 5 to 95. |
| [setAztecSymbolMode()](#setaztecsymbolmode) ~~(deprecated)~~ | Sets a Aztec Symbol mode. Default value: AztecSymbolMode.Auto. |
| [setECIEncoding()](#seteciencoding) | Sets ECI encoding. Used when AztecEncodeMode is Auto. Default value: ISO-8859-1 |
| [setEncodeMode(value)](#setencodemode) | Sets a Aztec encode mode. Default value: Auto. |
| [setErrorLevel()](#seterrorlevel) | Level of error correction of Aztec types of barcode. Value should between 5 to 95. |
| [setLayersCount()](#setlayerscount) | Sets layers count of Aztec symbol. Layers count should be in range from 1 to 3 for Compact mode and in range from 1 to 3 |
| [setReaderInitialization()](#setreaderinitialization) | Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization. |
| [setStructuredAppendBarcodeId()](#setstructuredappendbarcodeid) | Barcode ID for Structured Append mode of Aztec barcode. Barcode ID should be in range from 1 to barcodes count. Default  |
| [setStructuredAppendBarcodesCount()](#setstructuredappendbarcodescount) | Barcodes count for Structured Append mode of Aztec barcode. Barcodes count should be in range from 1 to 26. Default valu |
| [setStructuredAppendFileId()](#setstructuredappendfileid) | File ID for Structured Append mode of Aztec barcode (optional field). File ID should not contain spaces. Default value:  |
| [setSymbolMode(value)](#setsymbolmode) | Sets a Aztec Symbol mode. Default value: AztecSymbolMode.Auto. |
| [toString()](#tostring) | Returns a human-readable string representation of this `AztecParameters`. |

### getAspectRatio() {#getaspectratio}

Height/Width ratio of 2D BarCode module.

### getAztecEncodeMode() {#getaztecencodemode}

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

Gets a Aztec encode mode. Default value: Auto.

### getAztecErrorLevel() {#getaztecerrorlevel}

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

Level of error correction of Aztec types of barcode. Value should between 5 to 95.

### getAztecSymbolMode() {#getaztecsymbolmode}

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

Gets a Aztec Symbol mode. Default value: AztecSymbolMode.Auto.

### getECIEncoding() {#geteciencoding}

Gets ECI encoding. Used when AztecEncodeMode is Auto. Default value: ISO-8859-1

### getEncodeMode() {#getencodemode}

Gets a Aztec encode mode. Default value: Auto.

**Returns:** a Aztec encode mode.

### getErrorLevel() {#geterrorlevel}

Level of error correction of Aztec types of barcode. Value should between 5 to 95.

### getLayersCount() {#getlayerscount}

Gets layers count of Aztec symbol. Layers count should be in range from 1 to 3 for Compact mode and in range from 1 to 32 for Full Range mode. Default value: 0 (auto).

### getStructuredAppendBarcodeId() {#getstructuredappendbarcodeid}

Barcode ID for Structured Append mode of Aztec barcode. Barcode ID should be in range from 1 to barcodes count. Default value: 0

### getStructuredAppendBarcodesCount() {#getstructuredappendbarcodescount}

Barcodes count for Structured Append mode of Aztec barcode. Barcodes count should be in range from 1 to 26. Default value: 0

### getStructuredAppendFileId() {#getstructuredappendfileid}

File ID for Structured Append mode of Aztec barcode (optional field). File ID should not contain spaces. Default value: empty string

### getSymbolMode() {#getsymbolmode}

Gets a Aztec Symbol mode. Default value: AztecSymbolMode.Auto.

**Returns:** a Aztec Symbol mode.

### isReaderInitialization() {#isreaderinitialization}

Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization.

### setAspectRatio() {#setaspectratio}

Height/Width ratio of 2D BarCode module.

### setAztecEncodeMode() {#setaztecencodemode}

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

Sets a Aztec encode mode. Default value: Auto.

### setAztecErrorLevel() {#setaztecerrorlevel}

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

Level of error correction of Aztec types of barcode. Value should between 5 to 95.

### setAztecSymbolMode() {#setaztecsymbolmode}

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

Sets a Aztec Symbol mode. Default value: AztecSymbolMode.Auto.

### setECIEncoding() {#seteciencoding}

Sets ECI encoding. Used when AztecEncodeMode is Auto. Default value: ISO-8859-1

### setEncodeMode(value) {#setencodemode}

Sets a Aztec encode mode. Default value: Auto.

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

### setErrorLevel() {#seterrorlevel}

Level of error correction of Aztec types of barcode. Value should between 5 to 95.

### setLayersCount() {#setlayerscount}

Sets layers count of Aztec symbol. Layers count should be in range from 1 to 3 for Compact mode and in range from 1 to 32 for Full Range mode. Default value: 0 (auto).

### setReaderInitialization() {#setreaderinitialization}

Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization.

### setStructuredAppendBarcodeId() {#setstructuredappendbarcodeid}

Barcode ID for Structured Append mode of Aztec barcode. Barcode ID should be in range from 1 to barcodes count. Default value: 0

### setStructuredAppendBarcodesCount() {#setstructuredappendbarcodescount}

Barcodes count for Structured Append mode of Aztec barcode. Barcodes count should be in range from 1 to 26. Default value: 0

### setStructuredAppendFileId() {#setstructuredappendfileid}

File ID for Structured Append mode of Aztec barcode (optional field). File ID should not contain spaces. Default value: empty string

### setSymbolMode(value) {#setsymbolmode}

Sets a Aztec Symbol mode. Default value: AztecSymbolMode.Auto.

| Parameter | Description |
| --- | --- |
| value | a Aztec Symbol mode. |

### toString() {#tostring}

Returns a human-readable string representation of this `AztecParameters`.

**Returns:** A string that represents this `AztecParameters`.
