encodeSegments

tested

Returns a QR Code representing the given segments with the given encoding parameters. The smallest possible QR Code version within the given range is automatically chosen for the output. This is a mid-level API; the high-level API is encodeText() and encodeBinary().

Source Tests

Signature

export function encodeSegments(
  segs: readonly QrSegment[],
  ecl: QrCodeEcc,
  minVersion = 1,
  maxVersion = 40,
  mask = -1,
  boostEcl = true,
): QrCode{ ... }

Parameters

Parameter	Type	Default	Description
`segs`	`readonly QrSegment[]`	—	—
`ecl`	`QrCodeEcc`	—	—
`minVersion`?	`number`	`1`	—
`maxVersion`?	`number`	`40`	—
`mask`?	`number`	`-1`	—
`boostEcl`?	`boolean`	`true`	—

Returns

QrCode

Property	Type	Default	Description
`size`	`number`	—	The width and height of this QR Code, measured in modules, between 21 and 177 (inclusive).
`mask`	`number`	—	The index of the mask pattern used in this QR Code, which is between 0 and 7 (inclusive).
`modules`	`Uint8Array`	—	The modules of this QR Code (0 = light, 1 = dark). Flat row-major Uint8Array.
`types`	`Int8Array`	—	Data type of each module. Flat row-major Int8Array.
`version`	`number`	—	—
`ecc`	`QrCodeEcc`	—	—
`getModule`	`(x: number, y: number) => boolean`	—	Returns the color of the module (pixel) at the given coordinates. false for light, true for dark. Out of bounds returns false (light).
`getType`	`(x: number, y: number) => QrCodeDataType`	—	Returns the data type of the module at the given coordinates.
`drawFunctionPatterns`	`() => void`	—	—
`drawFormatBits`	`(mask: number) => void`	—	—
`drawVersion`	`() => void`	—	—
`drawFinderPattern`	`(x: number, y: number) => void`	—	—
`drawAlignmentPattern`	`(x: number, y: number) => void`	—	—
`setFunctionModule`	`(x: number, y: number, isDark: number, type?: QrCodeDataType) => void`	—	—
`addEccAndInterleave`	`(data: readonly number[]) => number[]`	—	—
`drawCodewords`	`(data: readonly number[]) => void`	—	—
`applyMask`	`(mask: number) => void`	—	—
`getPenaltyScore`	`() => number`	—	—
`getAlignmentPatternPositions`	`() => number[]`	—	—