Module: @nginstack/engine/lib/barcode/QRCode

Classes

QRCode

Type Definitions


QRCodeOptions

Properties:
Name Type Argument Description
scale number <optional>

Fator de escala. É o tamanho de um módulo do QR Code em pixels. Um valor 4 significa que um módulo é um quadrado de 4x4 pixels.

O valor padrão é 4.

margin number <optional>

Espessura da margem de segurança em número de módulos.

O valor padrão é 4.

width number <optional>

Força uma largura específica em pixels para a imagem. Imagens pequenas demais para alocar o QR Code geram erro.

Esta opção muda o comportamento do parâmetro "margin", que passa a não mais definir um tamanho fixo para a margem, mas sim um tamanho mínimo.

Esta opção tem precedência sobre o parâmetro "scale".

errorCorrection string <optional>

Nível de correção de erro. Indica a porcentagem máxima de perda de informação possível de ser recuperada na leitura do QR Code.

Os valores possíveis são:

  • QRCode.ECC_LOW ou 'L' (7%)
  • QRCode.ECC_MEDIUM ou 'M' (15%)
  • QRCode.ECC_QUARTILE ou 'Q' (25%)
  • QRCode.ECC_HIGH ou 'H' (30%).

O valor padrão é QRCode.ECC_MEDIUM.

lightColor string <optional>

Cor de fundo. Aceita RGB ou RGBA no formato hexadecimal. Deve ser uma cor mais clara do que a definida pelo parâmetro "darkColor".

O valor padrão é #FFFFFF (branco).

Exemplos: #FAFAFA, #FBFBFBAA.

darkColor string <optional>

Cor dos módulos. Aceita RGB ou RGBA no formato hexadecimal. Deve ser uma cor mais escura do que a definida pelo parâmetro "lightColor".

O valor padrão é #000000 (preto).

Exemplos: #0B000C, #010101AA.

ignoreContrastCheck boolean <optional>

Se verdadeiro, ignora a validação de contraste.

Por padrão, é realizado o cálculo de luminosidade das cores para checar se o contraste entre elas é alto suficiente para que o QR Code seja lido corretamente. Cores com transparência não passam por essa validação.

Importante: não há garantia de que QR Codes com contrastes muito baixos, mesmo quando validados, sejam reconhecidos por todos os leitores.