JSDoc: Global

Members

(constant) CHAR_TO_ORD :Object.<{}>

ISO/IEC 18004:2000 Table 5

Type:

Object.<{}>

Source:

Data/AlphaNum.js, line 16

(constant) ECC_L

from EccLevel

Source:

Common/constants.js, line 17

(constant) IS_DARK :number|int

Type:

number | int

Source:

Common/constants.js, line 84

(constant) MASK_PATTERN_AUTO :number|int

Type:

number | int

Source:

Common/constants.js, line 27

(protected, constant) MATRIX_NEIGHBOURS :Array.<Array.<number>>|Array.<Array.<int>>

Map of flag => coord

Type:

Array.<Array.<number>> | Array.<Array.<int>>

Source:

Common/constants.js, line 167

See:

QRMatrix::checkNeighbours()

(constant) MATRIX_NEIGHBOUR_FLAGS :Array.<number>|Array.<int>

Type:

Array.<number> | Array.<int>

Source:

Common/constants.js, line 148

(constant) MODE_INTERFACES :Array.<string>

Map of data mode => interface (detection order)

Type:

Array.<string>

Source:

QRCode.js, line 26

(constant) MODE_LENGTH_BITS

mode length bits for the version breakpoints 1-9, 10-26 and 27-40 ISO/IEC 18004:2000 Table 3 - Number of bits in Character Count Indicator

Source:

Common/Mode.js, line 17

(constant) MODE_NUMBER

from Mode

Source:

Common/constants.js, line 58

(constant) MODULE_VALUES_KEYS :Array.<number>|Array.<int>

Type:

Array.<number> | Array.<int>

Source:

Common/constants.js, line 182

(constant) M_ALIGNMENT :number|int

Type:

number | int

Source:

Common/constants.js, line 103

(constant) M_ALIGNMENT_DARK :number|int

Type:

number | int

Source:

Common/constants.js, line 124

(constant) M_DARKMODULE :number|int

Type:

number | int

Source:

Common/constants.js, line 118

(constant) M_DARKMODULE_LIGHT :number|int

Type:

number | int

Source:

Common/constants.js, line 139

(constant) M_DATA :number|int

Type:

number | int

Source:

Common/constants.js, line 97

(constant) M_DATA_DARK :number|int

Type:

number | int

Source:

Common/constants.js, line 120

(constant) M_FINDER :number|int

Type:

number | int

Source:

Common/constants.js, line 99

(constant) M_FINDER_DARK :number|int

Type:

number | int

Source:

Common/constants.js, line 122

(constant) M_FINDER_DOT :number|int

Type:

number | int

Source:

Common/constants.js, line 132

(constant) M_FINDER_DOT_LIGHT :number|int

Type:

number | int

Source:

Common/constants.js, line 141

(constant) M_FORMAT :number|int

Type:

number | int

Source:

Common/constants.js, line 107

(constant) M_FORMAT_DARK :number|int

Type:

number | int

Source:

Common/constants.js, line 128

(constant) M_LOGO :number|int

Type:

number | int

Source:

Common/constants.js, line 88

(constant) M_LOGO_DARK :number|int

Type:

number | int

Source:

Common/constants.js, line 90

(constant) M_NULL :number|int

Type:

number | int

Source:

Common/constants.js, line 86

(constant) M_QUIETZONE :number|int

Type:

number | int

Source:

Common/constants.js, line 111

(constant) M_QUIETZONE_DARK :number|int

Type:

number | int

Source:

Common/constants.js, line 145

(constant) M_SEPARATOR :number|int

Type:

number | int

Source:

Common/constants.js, line 101

(constant) M_SEPARATOR_DARK :number|int

Type:

number | int

Source:

Common/constants.js, line 143

(constant) M_TIMING :number|int

Type:

number | int

Source:

Common/constants.js, line 105

(constant) M_TIMING_DARK :number|int

Type:

number | int

Source:

Common/constants.js, line 126

(constant) M_VERSION :number|int

Type:

number | int

Source:

Common/constants.js, line 109

(constant) M_VERSION_DARK :number|int

Type:

number | int

Source:

Common/constants.js, line 130

(constant) TOTAL_CODEWORDS :Array.<number>|Array.<int>

Type:

Array.<number> | Array.<int>

Source:

Common/Version.js, line 163

(constant) VERSION_AUTO :number|int

Type:

number | int

Source:

Common/constants.js, line 73

Methods

(protected) _fromIterable($options) → {void}

Parameters:

Name	Type	Description
`$options`	Object.<{}>

Source:

QROptions.js, line 398

Returns:

Type: void

(protected) _set_canvasMimeType($canvasImageType) → {void}

set canvas image type

Parameters:

Name	Type	Description
`$canvasImageType`	string

Source:

QROptions.js, line 687

Returns:

Type: void

(protected) _set_circleRadius($circleRadius) → {void}

clamp/set SVG circle radius

Parameters:

Name	Type	Description
`$circleRadius`	number \| float

Source:

QROptions.js, line 667

Returns:

Type: void

(protected) _set_eccLevel($eccLevel) → {void}

sets the error correction level

Parameters:

Name	Type	Description
`$eccLevel`	number \| int

Source:

QROptions.js, line 504

Throws:

QRCodeException

Returns:

Type: void

(protected) _set_logoSpaceHeight($height) → {void}

clamp/set logo space height

Parameters:

Name	Type	Description
`$height`	number \| int

Source:

QROptions.js, line 607

Returns:

Type: void

(protected) _set_logoSpaceStartX($startX) → {void}

clamp/set horizontal logo space start

Parameters:

Name	Type	Description
`$startX`	number \| int \| null

Source:

QROptions.js, line 627

Returns:

Type: void

(protected) _set_logoSpaceStartY($startY) → {void}

clamp/set vertical logo space start

Parameters:

Name	Type	Description
`$startY`	number \| int \| null

Source:

QROptions.js, line 647

Returns:

Type: void

(protected) _set_logoSpaceWidth($width) → {void}

clamp/set logo space width

Parameters:

Name	Type	Description
`$width`	number \| int

Source:

QROptions.js, line 587

Returns:

Type: void

(protected) _set_maskPattern($maskPattern) → {void}

sets/clamps the mask pattern

Parameters:

Name	Type	Description
`$maskPattern`	number \| int

Source:

QROptions.js, line 529

Returns:

Type: void

(protected) _set_quietzoneSize($quietzoneSize) → {void}

sets/clamps the quiet zone size

Parameters:

Name	Type	Description
`$quietzoneSize`	number \| int

Source:

QROptions.js, line 553

Returns:

Type: void

(protected) _set_version($version) → {void}

sets/clamps the version number

Parameters:

Name	Type	Description
`$version`	number \| int

Source:

QROptions.js, line 483

Returns:

Type: void

(protected) _set_versionMax($versionMax) → {void}

sets the maximum version number

Parameters:

Name	Type	Description
`$versionMax`	number \| int

Source:

QROptions.js, line 463

Returns:

Type: void

(protected) _set_versionMin($versionMin) → {void}

sets the minimum version number

Parameters:

Name	Type	Description
`$versionMin`	number \| int

Source:

QROptions.js, line 443

Returns:

Type: void

addAlphaNumSegment() → {QRCode}

Adds an alphanumeric data segment ISO/IEC 18004:2000 8.3.3 - Alphanumeric Mode

Source:

QRCode.js, line 228

Returns:

Type: QRCode

addByteSegment() → {QRCode}

Adds an 8-bit byte data segment ISO/IEC 18004:2000 8.3.4 - 8-bit Byte Mode

Source:

QRCode.js, line 241

Returns:

Type: QRCode

(protected) addMatrixModifications($QRMatrix) → {QRMatrix}

add matrix modifications after mask pattern evaluation and before handing over to output

Parameters:

Name	Type	Description
`$QRMatrix`	QRMatrix

Source:

QRCode.js, line 138

Returns:

Type: QRMatrix

addNumericSegment() → {QRCode}

Adds a numeric data segment ISO/IEC 18004:2000 8.3.2 - Numeric Mode

Source:

QRCode.js, line 215

Returns:

Type: QRCode

addSegment() → {QRCode}

Adds a data segment ISO/IEC 18004:2000 8.3.6 - Mixing modes ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length

Source:

QRCode.js, line 191

Returns:

Type: QRCode

ansi8($str, $color, $background) → {string}

Parameters:

Name	Type	Default
`$str`	string
`$color`	number \| int
`$background`	boolean	null

Source:

Output/QRStringText.js, line 71

Returns:

Type: string

array_combine(keys, values) → {Object.<{}>|boolean}

Parameters:

Name	Type	Description
`keys`	Array
`values`	Array

Source:

Common/PHPJS.js, line 79

Returns:

Type: Object.<{}> | boolean

array_fill($count, $value) → {Array}

not an exact implementation, we're ignoring the $start_index parameter, which is always 0 here

Parameters:

Name	Type	Description
`$count`	number \| int
`$value`	*

Source:

Common/PHPJS.js, line 17

Returns:

Type: Array

check($x, $y) → {boolean}

Checks whether a module is true (dark) or false (light) Also, returns false if the given coordinates are out of range. true => $value & 0x800 === 0x800 false => $value & 0x800 === 0

Parameters:

Name	Type	Description
`$x`	number \| int
`$y`	number \| int

Source:

Data/QRMatrix.js, line 312

Returns:

Type: boolean

checkNeighbours($x, $y, $M_TYPE) → {number|int}

Checks the status neighbouring modules of the given module at ($x, $y) and returns a bitmask with the results. The 8 flags of the bitmask represent the status of each of the neighbouring fields, starting with the lowest bit for top left, going clockwise: 0 1 2 7 # 3 6 5 4

Parameters:

Name	Type	Default
`$x`	number \| int
`$y`	number \| int
`$M_TYPE`	number \| int \| null	null

Source:

Data/QRMatrix.js, line 348

Returns:

Type: number | int

checkType($x, $y, $M_TYPE) → {boolean}

Checks whether a module is of the given $M_TYPE true => $value & $M_TYPE === $M_TYPE Also, returns false if the given coordinates are out of range.

Parameters:

Name	Type	Description
`$x`	number \| int
`$y`	number \| int
`$M_TYPE`	number \| int

Source:

Data/QRMatrix.js, line 269

Returns:

Type: boolean

checkTypeIn($x, $y, $M_TYPES) → {boolean}

Checks whether the module at ($x, $y) is in the given array of $M_TYPES, returns true if a match is found, otherwise false.

Parameters:

Name	Type	Description
`$x`	number \| int
`$y`	number \| int
`$M_TYPES`	Array.<number> \| Array.<int>

Source:

Data/QRMatrix.js, line 288

Returns:

Type: boolean

(protected) clampLogoSpaceValue($value) → {number|int}

clamp the logo space values between 0 and maximum length (177 modules at version 40)

Parameters:

Name	Type	Description
`$value`	number \| int

Source:

QROptions.js, line 573

Returns:

Type: number | int

clear() → {BitBuffer}

clears the buffer

Source:

Common/BitBuffer.js, line 102

Returns:

Type: BitBuffer

clearSegments() → {QRCode}

Clears the data segments array

Source:

QRCode.js, line 202

Returns:

Type: QRCode

clone($object) → {Object.<*>}

Parameters:

Name	Type	Description
`$object`	Object.<*>

Source:

Common/PHPJS.js, line 152

Returns:

Type: Object.<*>

(protected) collectModules($transform) → {Object.<{}>}

collects the modules per QRMatrix.M_* type and runs a $transform functio on each module and returns an array with the transformed modules The transform callback is called with the following parameters: $x - current column $y - current row $M_TYPE - field value $M_TYPE_LAYER - (possibly modified) field value that acts as layer id

Parameters:

Name	Type	Description
`$transform`	function

Source:

Output/QROutputAbstract.js, line 272

Returns:

Type: Object.<{}>

(protected) createMarkup()

Source:

Output/QRMarkupSVG.js, line 63

(protected) createMatrix($size, $value) → {Object.<{}>}

Creates a 2-dimensional array (square) of the given $size

Parameters:

Name	Type	Description
`$size`	number \| int
`$value`	number \| int

Source:

Data/QRMatrix.js, line 89

Returns:

Type: Object.<{}>

(protected) drawImage() → {void}

Source:

Output/QRCanvas.js, line 138

Returns:

Type: void

dump() → {HTMLCanvasElement|string|*}

Source:

Output/QRCanvas.js, line 108

Throws:

QRCodeOutputException

Returns:

Type: HTMLCanvasElement | string | *

dump() → {HTMLElement|SVGElement|ChildNode|string|*}

Source:

Output/QRMarkupSVG.js, line 42

Returns:

Type: HTMLElement | SVGElement | ChildNode | string | *

(abstract) dump($file) → {*}

generates the output, optionally dumps it to a file, and returns it

Parameters:

Name	Type	Default	Description
`$file`	string \| null	null

Source:

Output/QROutputInterface.js, line 37

Returns:

Type: *

dump()

Source:

Output/QRStringJSON.js, line 33

dump()

Source:

Output/QRStringText.js, line 44

exp($a) → {number|int}

Parameters:

Name	Type	Description
`$a`	number \| int

Source:

Common/GF256.js, line 76

Returns:

2 to the power of a in GF(size)

Type: number | int

flip($x, $y) → {QRMatrix}

Flips the value of the module

Parameters:

Name	Type	Description
`$x`	number \| int
`$y`	number \| int

Source:

Data/QRMatrix.js, line 247

Returns:

Type: QRMatrix

get($x, $y) → {number|int}

Returns the value of the module at position [$x, $y] or -1 if the coordinate is outside of the matrix

Parameters:

Name	Type	Description
`$x`	number \| int
`$y`	number \| int

Source:

Data/QRMatrix.js, line 178

Returns:

Type: number | int

getAlignmentPattern() → {Array.<number>|Array.<int>}

the alignment patterns for the current version

Source:

Common/Version.js, line 277

Returns:

Type: Array.<number> | Array.<int>

getBestPattern($QRMatrix) → {MaskPattern}

Evaluates the matrix of the given data interface and returns a new mask pattern instance for the best result

Parameters:

Name	Type	Description
`$QRMatrix`	QRMatrix

Source:

Common/MaskPattern.js, line 99

Returns:

Type: MaskPattern

getBuffer() → {Array.<number>|Array.<int>}

returns the buffer content

Source:

Common/BitBuffer.js, line 93

Returns:

Type: Array.<number> | Array.<int>

(protected) getCharCount() → {number|int}

returns the character count of the $data string

Source:

Data/QRDataModeAbstract.js, line 55

Returns:

Type: number | int

getCoefficient($degree) → {number|int}

Parameters:

Name	Type	Description
`$degree`	number \| int

Source:

Common/GenericGFPoly.js, line 75

Returns:

$coefficient of x^degree term in this polynomial

Type: number | int

getCoefficients() → {Array.<number>|Array.<int>}

Source:

Common/GenericGFPoly.js, line 82

Returns:

Type: Array.<number> | Array.<int>

(protected) getCssClass()

Source:

Output/QRMarkupSVG.js, line 29

getDataMode() → {number|int}

returns the current data mode constant

Source:

Data/QRDataModeAbstract.js, line 66

Returns:

Type: number | int

(abstract) getDataMode() → {number|int}

returns the current data mode constant

Source:

Data/QRDataModeInterface.js, line 21

Returns:

Type: number | int

getDefaultModuleValue()

Source:

Output/QRCanvas.js, line 75

(protected) getDefaultModuleValue($isDark)

Returns a defualt value for either dark or light modules (return value depends on the output module)

Parameters:

Name	Type	Description
`$isDark`	boolean

Source:

Output/QROutputAbstract.js, line 148

getDefaultModuleValue()

Source:

Output/QRStringText.js, line 23

getDegree() → {number|int}

Source:

Common/GenericGFPoly.js, line 89

Returns:

$degree of this polynomial

Type: number | int

getDimension() → {number|int}

the matrix size for the given version

Source:

Common/Version.js, line 259

Returns:

Type: number | int

getEccLevel() → {EccLevel}

Returns the current ECC level instance

Source:

Data/QRMatrix.js, line 146

Returns:

Type: EccLevel

getLength() → {number|int}

returns the current buffer length

Source:

Common/BitBuffer.js, line 84

Returns:

Type: number | int

getLengthBitsForMode($mode)

returns the array of length bits for the given mode

Parameters:

Name	Type	Description
`$mode`	number \| int

Source:

Common/Mode.js, line 64

getLengthBitsForVersion($mode, $version) → {number|int}

returns the length bits for the version breakpoints 1-9, 10-26 and 27-40

Parameters:

Name	Type	Description
`$mode`	number \| int
`$version`	number \| int

Source:

Common/Mode.js, line 37

Throws:

QRCodeException

Returns:

Type: number | int

(protected) getLengthBitsForVersion($versionNumber) → {number|int}

Parameters:

Name	Type	Description
`$versionNumber`	number \| int

Source:

Data/QRDataModeAbstract.js, line 76

Returns:

Type: number | int

getLengthInBits()

Source:

Data/AlphaNum.js, line 41

getLengthInBits()

Source:

Data/Byte.js, line 28

getLengthInBits()

Source:

Data/Numeric.js, line 30

(abstract) getLengthInBits() → {number|int}

retruns the length in bits of the data string

Source:

Data/QRDataModeInterface.js, line 29

Returns:

Type: number | int

getLevel() → {number|int}

returns the current ECC level

Source:

Common/EccLevel.js, line 165

Returns:

Type: number | int

getMask() → {function}

Returns a closure that applies the mask for the chosen mask pattern. Note that the diagram in section 6.8.1 is misleading since it indicates that i is column position and j is row position. In fact, as the text says, i is row position and j is column position.

Source:

Common/MaskPattern.js, line 78

See:

Returns:

Type: function

getMaskPattern() → {MaskPattern}

Returns the current mask pattern instance

Source:

Data/QRMatrix.js, line 155

Returns:

Type: MaskPattern

getMatrix($boolean) → {Array.<Array.<number>>|Array.<Array.<int>>|Array.<Array.<boolean>>}

Returns the data matrix, returns a pure boolean representation if $boolean is set to true

Parameters:

Name	Type	Default	Description
`$boolean`	boolean	false

Source:

Data/QRMatrix.js, line 117

Returns:

Type: Array.<Array.<number>> | Array.<Array.<int>> | Array.<Array.<boolean>>

getMaxBits() → {Array.<number>|Array.<int>}

Source:

Common/EccLevel.js, line 196

Returns:

an array with the max bit lengths for version 1-40 and the current ECC level

Type: Array.<number> | Array.<int>

getMaxBitsForVersion($version) → {number|int}

Returns the maximum bit length for the given version and current ECC level

Parameters:

Name	Type	Description
`$version`	Version

Source:

Common/EccLevel.js, line 214

Returns:

Type: number | int

(protected) getModuleValue($M_TYPE)

Returns the prepared value for the given $M_TYPE

Parameters:

Name	Type	Description
`$M_TYPE`	number \| int

Source:

Output/QROutputAbstract.js, line 196

Throws:

if $moduleValues[$M_TYPE] doesn't exist
Type QRCodeOutputException

(protected) getModuleValueAt($x, $y)

Returns the prepared module value at the given coordinate [$x, $y] (convenience)

Parameters:

Name	Type	Description
`$x`	number \| int
`$y`	number \| int

Source:

Output/QROutputAbstract.js, line 213

getOrdinal()

returns the ordinal value of the current ECC level references to the keys of the following tables:

Source:

Common/EccLevel.js, line 178

See:

MAX_BITS
FORMAT_PATTERN
RSBLOCKS

getOutputDimensions()

Source:

Output/QRCanvas.js, line 82

(protected) getOutputDimensions()

Returns a 2 element array with the current output width and height The type and units of the values depend on the output class. The default value is the current module count.

Source:

Output/QROutputAbstract.js, line 101

getPattern() → {number|int}

Returns the current mask pattern

Source:

Common/MaskPattern.js, line 63

Returns:

Type: number | int

getQRMatrix() → {QRMatrix}

Returns a QRMatrix object for the given $data and current QROptions

Source:

QRCode.js, line 119

Throws:

QRCodeDataException

Returns:

Type: QRMatrix

getRSBlocks($eccLevel) → {Array}

returns ECC block information for the given $version and $eccLevel

Parameters:

Name	Type	Description
`$eccLevel`	EccLevel

Source:

Common/Version.js, line 288

Returns:

Type: Array

getSize() → {number|int}

Returns the absoulute size of the matrix, including quiet zone (after setting it). size = version * 4 + 17 [ + 2 * quietzone size]

Source:

Data/QRMatrix.js, line 166

Returns:

Type: number | int

getTotalCodewords() → {number|int}

returns the maximum codewords for the current version

Source:

Common/Version.js, line 297

Returns:

Type: number | int

getVersion() → {Version}

Returns the current version instance

Source:

Data/QRMatrix.js, line 137

Returns:

Type: Version

getVersionNumber() → {number|int}

returns the current version number

Source:

Common/Version.js, line 250

Returns:

Type: number | int

getVersionPattern() → {number|int|null}

the version pattern for the given version

Source:

Common/Version.js, line 268

Returns:

Type: number | int | null

(protected) getViewBox() → {string}

returns the value for the SVG viewBox attribute

Source:

Output/QRMarkupSVG.js, line 90

See:

Returns:

Type: string

getformatPattern($maskPattern) → {number|int}

returns the format pattern for the given $eccLevel and $maskPattern

Parameters:

Name	Type	Description
`$maskPattern`	MaskPattern

Source:

Common/EccLevel.js, line 189

Returns:

Type: number | int

returns the

Source:

Output/QRMarkupSVG.js, line 102

Returns:

Type: string

initFunctionalPatterns() → {QRMatrix}

shortcut to initialize the functional patterns

Source:

Data/QRMatrix.js, line 98

Returns:

Type: QRMatrix

(protected) initOutputInterface($QRMatrix) → {QROutputAbstract}

initializes a fresh built-in or custom QROutputInterface

Parameters:

Name	Type	Description
`$QRMatrix`	QRMatrix

Source:

QRCode.js, line 168

Throws:

QRCodeOutputException

Returns:

Type: QROutputAbstract

interleaveEcBytes($bitBuffer) → {Object.<{}>}

ECC interleaving

Parameters:

Name	Type	Description
`$bitBuffer`	BitBuffer

Source:

Common/ReedSolomonEncoder.js, line 58

Throws:

QRCodeException

Returns:

Type: Object.<{}>

intval($var, $base) → {number|int}

Parameters:

Name	Type	Default	Description
`$var`	*
`$base`	number \| null	null

Source:

Common/PHPJS.js, line 51

Returns:

Type: number | int

invert() → {QRMatrix}

Inverts the values of the whole matrix ISO/IEC 18004:2015 Section 6.2 - Reflectance reversal

Source:

Data/QRMatrix.js, line 622

Returns:

Type: QRMatrix

isDark($M_TYPE) → {boolean}

Checks whether the given $M_TYPE is a dark value

Parameters:

Name	Type	Description
`$M_TYPE`	number \| int

Source:

Data/QRMatrix.js, line 328

Returns:

Type: boolean

isZero() → {boolean}

Source:

Common/GenericGFPoly.js, line 96

Returns:

true if this polynomial is the monomial "0"

Type: boolean

isset($accessor)

Checks to see if a value in a nested array is set. isset(() => some.nested.value)

Parameters:

Name	Type	Description
`$accessor`	function	Function that returns our value

Source:

Common/PHPJS.js, line 35

log($a) → {number|int}

Parameters:

Name	Type	Description
`$a`	number \| int

Source:

Common/GF256.js, line 94

Throws:

QRCodeException

Returns:

base 2 log of a in GF(size)

Type: number | int

mask($maskPattern) → {QRMatrix}

Applies/reverses the mask pattern ISO/IEC 18004:2000 Section 8.8.1

Parameters:

Name	Type	Description
`$maskPattern`	MaskPattern

Source:

Data/QRMatrix.js, line 789

Returns:

Type: QRMatrix

mod($other) → {GenericGFPoly}

Parameters:

Name	Type	Description
`$other`	GenericGFPoly

Source:

Common/GenericGFPoly.js, line 128

Returns:

Type: GenericGFPoly

(protected) module() → {void}

Source:

Output/QRCanvas.js, line 160

Returns:

Type: void

(protected) module($x, $y, $M_TYPE) → {string}

returns a path segment for a single module

Parameters:

Name	Type	Description
`$x`	number \| int
`$y`	number \| int
`$M_TYPE`	number \| int

Source:

Output/QRMarkupSVG.js, line 181

See:

https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d

Returns:

Type: string

(protected) module() → {*}

Creates an array element for a single module

Source:

Output/QRStringJSON.js, line 103

Returns:

Type: *

moduleValueIsValid()

Source:

Output/QRCanvas.js, line 37

moduleValueIsValid()

Source:

Output/QROutputAbstract.js, line 155

(abstract) moduleValueIsValid($value) → {boolean}

Determines whether the given value is valid

Parameters:

Name	Type	Description
`$value`	*

Source:

Output/QROutputInterface.js, line 28

Returns:

Type: boolean

moduleValueIsValid()

Source:

Output/QRStringText.js, line 37

multiply($a, $b)

Parameters:

Name	Type	Description
`$a`	number \| int
`$b`	number \| int

Source:

Common/GF256.js, line 109

Returns:

int product of a and b in GF(size)

multiply($other) → {GenericGFPoly}

Parameters:

Name	Type	Description
`$other`	GenericGFPoly

Source:

Common/GenericGFPoly.js, line 105

Returns:

Type: GenericGFPoly

ord($string) → {number|int}

Parameters:

Name	Type	Description
`$string`	string

Source:

Common/PHPJS.js, line 110

Returns:

Type: number | int

(protected) path($path, $M_TYPE) → {string}

renders and returns a single element

Parameters:

Name	Type	Description
`$path`	string
`$M_TYPE`	number \| int

Source:

Output/QRMarkupSVG.js, line 158

See:

https://developer.mozilla.org/en-US/docs/Web/SVG/Element/path

Returns:

Type: string

(protected) paths() → {string}

returns one or more SVG elements

Source:

Output/QRMarkupSVG.js, line 122

See:

https://developer.mozilla.org/en-US/docs/Web/SVG/Element/path

Returns:

Type: string

prepareModuleValue()

Source:

Output/QRCanvas.js, line 68

(protected) prepareModuleValue($value)

Returns the final value for the given input (return value depends on the output module)

Parameters:

Name	Type	Description
`$value`	*

Source:

Output/QROutputAbstract.js, line 137

prepareModuleValue()

Source:

Output/QRStringText.js, line 30

put($bits, $length) → {BitBuffer}

appends a sequence of bits

Parameters:

Name	Type	Description
`$bits`	number \| int
`$length`	number \| int

Source:

Common/BitBuffer.js, line 47

Returns:

Type: BitBuffer

putBit($bit) → {BitBuffer}

appends a single bit

Parameters:

Name	Type	Description
`$bit`	boolean

Source:

Common/BitBuffer.js, line 63

Returns:

Type: BitBuffer

render() → {*}

Renders a QR Code for the given $data and QROptions

Source:

QRCode.js, line 85

Returns:

Type: *

renderMatrix($QRMatrix, $file) → {*}

Renders a QR Code for the given QRMatrix and QROptions, saves $file optionally

Parameters:

Name	Type	Default	Description
`$QRMatrix`	QRMatrix
`$file`	string \| null	null

Source:

QRCode.js, line 109

Returns:

Type: *

rotate90()

Rotates the matrix by 90 degrees clock wise

Source:

Data/QRMatrix.js, line 609

(protected) row() → {*}

Creates an array element for a matrix row

Source:

Output/QRStringJSON.js, line 78

Returns:

Type: *

(protected) saveToFile($data, $file) → {void}

saves the qr data to a file

Parameters:

Name	Type	Description
`$data`	string
`$file`	string

Source:

Output/QROutputAbstract.js, line 248

See:

file_put_contents()
QROptions.cachefile

Throws:

QRCodeOutputException

Returns:

Type: void

set($x, $y, $value, $M_TYPE) → {QRMatrix}

Sets the $M_TYPE value for the module at position [$x, $y] true => $M_TYPE | 0x800 false => $M_TYPE

Parameters:

Name	Type	Description
`$x`	number \| int
`$y`	number \| int
`$value`	boolean
`$M_TYPE`	number \| int

Source:

Data/QRMatrix.js, line 200

Returns:

Type: QRMatrix

setAlignmentPattern() → {QRMatrix}

Draws the 5x5 alignment patterns ISO/IEC 18004:2000 Section 7.3.5

Source:

Data/QRMatrix.js, line 447

Returns:

Type: QRMatrix

setArea($startX, $startY, $width, $height, $value, $M_TYPE) → {QRMatrix}

Fills an area of $width * $height, from the given starting point [$startX, $startY] (top left) with $value for $M_TYPE.

Parameters:

Name	Type	Description
`$startX`	number \| int
`$startY`	number \| int
`$width`	number \| int
`$height`	number \| int
`$value`	boolean
`$M_TYPE`	number \| int

Source:

Data/QRMatrix.js, line 228

Returns:

Type: QRMatrix

setDarkModule() → {QRMatrix}

Sets the "dark module", that is always on the same position 1x1px away from the bottom left finder 4 * version + 9 or moduleCount - 8

Source:

Data/QRMatrix.js, line 377

Returns:

Type: QRMatrix

setData($dataSegments) → {QRData}

Sets the data string (internally called by the constructor)

Parameters:

Name	Type	Description
`$dataSegments`	Array.<QRDataModeAbstract>

Source:

Data/QRData.js, line 89

Returns:

Type: QRData

setFinderPattern() → {QRMatrix}

Draws the 7x7 finder patterns in the corners top left/right and bottom left ISO/IEC 18004:2000 Section 7.3.2

Source:

Data/QRMatrix.js, line 390

Returns:

Type: QRMatrix

setFormatInfo($maskPattern) → {QRMatrix}

Draws the format info along the finder patterns. If no $maskPattern, all format info modules will be set to false. ISO/IEC 18004:2000 Section 8.9

Parameters:

Name	Type	Default	Description
`$maskPattern`	MaskPattern \| null	null

Source:

Data/QRMatrix.js, line 529

Returns:

Type: QRMatrix

setLogoSpace($width, $height, $startX, $startY) → {QRMatrix}

Clears a space of $width * $height in order to add a logo or text. If no $height is given, the space will be assumed a square of $width. Additionally, the logo space can be positioned within the QR Code using $startX and $startY. If either of these are null, the logo space will be centered in that direction. ECC level "H" (30%) is required. The coordinates of $startX and $startY do not include the quiet zone: [0, 0] is always the top left module of the top left finder pattern, negative values go into the quiet zone top and left. Please note that adding a logo space minimizes the error correction capacity of the QR Code and created images may become unreadable, especially when printed with a chance to receive damage. Please test thoroughly before using this feature in production. This method should be called from within an output module (after the matrix has been filled with data). Note that there is no restiction on how many times this method could be called on the same matrix instance.

Parameters:

Name	Type	Default
`$width`	number \| int
`$height`	number \| int \| null	null
`$startX`	number \| int \| null	null
`$startY`	number \| int \| null	null

Source:

Data/QRMatrix.js, line 667

Throws:

QRCodeDataException

Returns:

Type: QRMatrix

(protected) setMatrixDimensions() → {void}

Sets/updates the matrix dimensions Call this method if you modify the matrix from within your custom module in case the dimensions have been changed

Source:

Output/QROutputAbstract.js, line 87

Returns:

Type: void

(protected) setMinMaxVersion($versionMin, $versionMax) → {void}

clamp min/max version number

Parameters:

Name	Type	Description
`$versionMin`	number \| int
`$versionMax`	number \| int

Source:

QROptions.js, line 427

Returns:

Type: void

(protected) setModuleValues() → {void}

Sets the initial module values

Source:

Output/QROutputAbstract.js, line 111

Returns:

Type: void

setOptions($options) → {QRCode}

Sets an options instance

Parameters:

Name	Type	Description
`$options`	QROptions

Source:

QRCode.js, line 69

Returns:

Type: QRCode

setQuietZone($quietZoneSize) → {QRMatrix}

Draws the "quiet zone" of $size around the matrix ISO/IEC 18004:2000 Section 7.3.7

Parameters:

Name	Type	Description
`$quietZoneSize`	number \| int

Source:

Data/QRMatrix.js, line 575

Throws:

QRCodeDataException

Returns:

Type: QRMatrix

setSeparators() → {QRMatrix}

Draws the separator lines around the finder patterns ISO/IEC 18004:2000 Section 7.3.3

Source:

Data/QRMatrix.js, line 416

Returns:

Type: QRMatrix

setTimingPattern() → {QRMatrix}

Draws the timing pattern (h/v checkered line between the finder patterns) ISO/IEC 18004:2000 Section 7.3.4

Source:

Data/QRMatrix.js, line 477

Returns:

Type: QRMatrix

setVersionNumber() → {QRMatrix}

Draws the version information, 2x 3x6 pixel ISO/IEC 18004:2000 Section 8.10

Source:

Data/QRMatrix.js, line 501

Returns:

Type: QRMatrix

testRule1($matrix, $height, $width) → {number|int}

Apply mask penalty rule 1 and return the penalty. Find repetitive cells with the same color and give penalty to them. Example: 00000 or 11111.

Parameters:

Name	Type	Description
`$matrix`	Array
`$height`	number \| int
`$width`	number \| int

Source:

Common/MaskPattern.js, line 131

Returns:

Type: number | int

testRule2($matrix, $height, $width) → {number|int}

Apply mask penalty rule 2 and return the penalty. Find 2x2 blocks with the same color and give penalty to them. This is actually equivalent to the spec's rule, which is to find MxN blocks and give a penalty proportional to (M-1)x(N-1), because this is the number of 2x2 blocks inside such a block.

Parameters:

Name	Type	Description
`$matrix`	Array
`$height`	number \| int
`$width`	number \| int

Source:

Common/MaskPattern.js, line 192

Returns:

Type: number | int

testRule3($matrix, $height, $width) → {number|int}

Apply mask penalty rule 3 and return the penalty. Find consecutive runs of 1:1:3:1:1:4 starting with black, or 4:1:1:3:1:1 starting with white, and give penalty to them. If we find patterns like 000010111010000, we give penalty once.

Parameters:

Name	Type	Description
`$matrix`	Array
`$height`	number \| int
`$width`	number \| int

Source:

Common/MaskPattern.js, line 233

Returns:

Type: number | int

testRule4($matrix, $height, $width) → {number|int}

Apply mask penalty rule 4 and return the penalty. Calculate the ratio of dark cells and give penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.