gpqr_scanner_config (JS)

  1. Description
  2. Usage
  3. Parameters
  4. Examples
    1. Add Support for PDF_417 and UPC_A
  5. Supported Barcode Types
  6. Since

Description

Filter the config passed to html5-qrcode.

Usage

gform.addFilter( 'gpqr_scanner_config', my_custom_function );

Parameters

  • config object

    Config used to initialize scanner.

  • instance object

    Current instance of the GP_QR_Code class.

  • supportedFormats array

    Array of supported formats such as QR Code, PDF 417, etc. Provided as a way to pass in additional formats to the config.

  • scanTypes array

    Array of scan types (camera and file). Provided as a way to change the scan types in the config.

Examples

Add Support for PDF_417 and UPC_A

/**
 * Gravity Perks // GP QR Code // Add Support for PDF_417 and UPC_A
 * https://gravitywiz.com/documentation/gravity-forms-qr-code/
 *
 * Instructions:
 * 
 * 1. Install this snippet with our free Custom JavaScript plugin.
 *    https://gravitywiz.com/gravity-forms-custom-javascript/
 */
window.gform.addFilter( 'gpqr_scanner_config', function( config, instance, formats ) {
	config['formatsToSupport'] = [ formats.QR_CODE, formats.PDF_417, formats.UPC_A ];
	return config;
} );

Supported Barcode Types

Currently GF QR Code supports scanning the following barcode types.

  • AZTEC
    Aztec 2D barcode format
  • CODABAR
    CODABAR 1D format
  • CODE_39
    Code 39 1D format
  • CODE_93
    Code 93 1D format
  • CODE_128
    Code 128 1D format
  • DATA_MATRIX
    Data Matrix 2D barcode format
  • EAN_8
    EAN-8 1D format
  • EAN_13
    EAN-13 1D format
  • ITF
    ITF (Interleaved Two of Five) 1D format
  • MAXICODE
    MaxiCode 2D barcode format
  • PDF_417
    PDF417 format
  • QR_CODE
    QR Code 2D barcode format
  • RSS_14
    RSS 14
  • RSS_EXPANDED
    RSS EXPANDED
  • UPC_A
    UPC-A 1D format
  • UPC_E
    UPC-E 1D format
  • UPC_EAN_EXTENSION
    UPC/EAN extension format. Not a stand-alone format.

Since

This filter is available since Gravity Forms QR Code 1.0-alpha-1.