Class Creator

The creator can be used to generate the QR code boolean matrix.

export

Hierarchy

Creator

Index

Constructors

constructor

Methods

Constructors

constructor

new Creator(opts?: CreatorOptions): Creator

- Defined in encode/Creator.ts:24
Parameters
- Optional opts: CreatorOptions
Returns Creator

Methods

add

add(qrContent: string | QRContent | QRContentObj): Creator

- Defined in encode/Creator.ts:219
Add content to creator.

Parameters
- qrContent: string | QRContent | QRContentObj
Returns Creator

clear

clear(): Creator

- Defined in encode/Creator.ts:208
Clear the data.

Returns Creator

clearMaskPattern

clearMaskPattern(): Creator

- Defined in encode/Creator.ts:155
Clear mask pattern.

Returns Creator

create

create(): Creator

- Defined in encode/Creator.ts:259
Create QR boolean matrix.

Returns Creator

getECIStatus

getECIStatus(): boolean

- Defined in encode/Creator.ts:165
Get ECI status.

Returns boolean

getErrorCorrectionLevel

getErrorCorrectionLevel(): ErrorCorrectionLevel

- Defined in encode/Creator.ts:95
Get the error correction level for this creator.

Returns ErrorCorrectionLevel

getMaskPattern

getMaskPattern(): Nullable<MaskPattern>

- Defined in encode/Creator.ts:123
Get mask pattern.

Returns Nullable<MaskPattern>

getMatrix

getMatrix(): QRMatrix

- Defined in encode/Creator.ts:56
Get the QR boolean matrix.

Returns QRMatrix

getMatrixSize

getMatrixSize(): number

- Defined in encode/Creator.ts:65
Get the QR boolean matrix size.

Returns number

getVersion

getVersion(): number

- Defined in encode/Creator.ts:74
Get version.

Returns number

setECIStatus

setECIStatus(enableECI: boolean): Creator

- Defined in encode/Creator.ts:175
Set ECI Status.

Parameters
- enableECI: boolean
Returns Creator

setErrorCorrectionLevel

setErrorCorrectionLevel(errorCorrectionLevel: ErrorCorrectionLevel): Creator

- Defined in encode/Creator.ts:105
Set the error correction level for this creator.

Parameters
- errorCorrectionLevel: ErrorCorrectionLevel
Returns Creator

setMaskPattern

setMaskPattern(maskPattern: MaskPattern): Creator

- Defined in encode/Creator.ts:133
Set mask pattern.

Parameters
- maskPattern: MaskPattern
Returns Creator

setVersion

setVersion(version: number): Creator

- Defined in encode/Creator.ts:84
Set version, 1 - 40.

Parameters
- version: number
Returns Creator

Generated using TypeDoc