QR API | app | app | This component uses the QR API app. |
Filename | filename | string | The filename that will be used to save in /tmp directory without extension
|
Size | size | string | Select a value from the drop down menu:s m l xl xxl xxxl custom |
Quiet Zone | quiteZone | string | Select a value from the drop down menu:0 1 2 3 4 5 6 7 8 9 10 11 12 |
Custom Size | customSize | integer | Parameter valid only if parameter size is set to custom. Use this parameter to specify the custom size of the QR Code image in pixels (including Quiet Zone, which is free area around QR Code to ensure scannability).
|
Error Correction | errorCorrection | string | Select a value from the drop down menu:L M Q H |
Data Pattern | dataPattern | string | Select a value from the drop down menu:RECT ROUND MINI_LEAF CHIPS FIREFLY ROUNDED_CORNERS VERTICAL_PIPES HORIZONTAL_PIPES VERTICAL_NIGHT_LIFE HORIZONTAL_NIGHT_LIFE PANCARDS CURVED_RECTS NAWABI_DARWAZA ROTATED_SQUARES ROTATED_RECTS HAND_IN_HANDS RANDOM_ROTATE ALTERNATE_DIAGONAL CIRCLE_ON_CORNERS CONNECTED_HAMMERS CONNECTED_CIRCLES POINTED_BEAKS MAZE CURVED_MAZE TRIANGLES VERTICAL_TRIANGLES HORIZONTAL_TRIANGLES HUT CIRCULAR_DIAGONAL LIGHT_CIRCLE LIGHT_SQUARE LIGHT_ROUNDED_CORNERS LIGHT_CIRCLE_SQUARE NOOVERLAP_ROUND_CORNER |
Eye Pattern | eyePattern | string | Select a value from the drop down menu:RECT_RECT ROUND_RECT RECT_CIRC ROUNDRECT_CIRC CIRC_CIRC BR_LEAF TR_LEAF BL_LEAF TL_LEAF TLBR_LEAF TRBL_LEAF TRBL_LEAF_CIRC TLBR_LEAF_CIRC TRBL_LEAF_DIAD RECT_DIAD UNI_LEAF BLOAT_RECT WARP_RECT0 CURVE_RECT DIST_RECT ZIGZAG WARP_RECT1 BLACK_HOLE STAR GRID SCION OCTAGON FLOWER HUT DARK_HUT |
Data Gradient Style | dataGradientStyle | string | Select a value from the drop down menu:Horizontal Vertical Diagonal ReverseDiagonal Radial Eye_Horizontal Eye_Vertical Eye_Diagonal Eye_ReverseDiagonal Eye_Radial None |
Data Gradient Start Color | dataGradientStartColor | string | Parameter valid and required only if poster.url is not specified. Use this parameter to EITHER add a color (in hex format #000000) to all data modules (if data_gradient_style is set to None) OR to add the start color to data modules (if data_gradient_style is not set to None).
|
Data Gradient End Color | dataGradientEndColor | string | Parameter valid only if poster.url is not specified and data_gradient_style is not set to None. Use this parameter to set the end color (in hex format #000000) to data modules.
|
Eye Color Inner | eyeColorInner | string | Parameter valid and required only if poster.url is not specified. Use this parameter to specify color (in hex format #000000) to the inner component of the QR Code (all three) eyes (position markers in the three corners).
|
Eye Color Outer | eyeColorOuter | string | Parameter valid and required only if poster.url is not specified. Use this parameter to specify color (in hex format #000000) to the outer component of the QR Code (all three) eyes (position markers in the three corners).
|
Background Color | backgroundColor | string | Parameter valid and required only if poster.url is not specified. Use this parameter to specify color (in hex format #000000) of the QR Codes' background including non-dark data modules. To remove background (i.e. make transparent), use value false. Tip: For highest scannability keep the background color as white i.e. #FFFFFF.
|
Logo URL | logoUrl | string | Parameter valid only if poster.url is not specified. Use this field if you want to design the QR Code with the 'Custom with Logo' feature. Otherwise, skip. Enter the URL of the image you want as a logo. Tip: Ensure the image source allows cross-domain access. Or simply use the Media feature to upload image and get URL or choose from our list of ready-made logos and icons. See the full list here
|
Logo Size | logoSize | integer | Parameter valid only if data in logo.url is specified. Enter the size of the logo image as a percentage (%) of size of logo. Tip: High logo size may make the QR Code unscannable. Test thoroughly before finalizing.
|
Logo Excavated | logoExcavated | boolean | Parameter valid only if data in logo.url is specified. Use this paramater to specify if the blocks around the logo should be remove (true) or should not be removed (false) Tip: If selecting true, set error correction to a higher-level to ensure loss of blocks doesn't affect scannability.
|
Logo Angle | logoAngle | integer | Parameter valid only if data in logo.url is specified. Use this parameter if you wish to rotate the image at an angle. Use values 1-359 (degrees) for clockwise rotation and -1 to -359 (degrees) for anti-clockwise rotation.
|
Logo Cache | logoCache | boolean | Parameter valid and required only if logo.url is specified. By default, it will be set to True. When set to True, the logo image provided will be cached for 10 minutes to improve performance. Set to False only if the image uploaded in the URL provided in logo.url field will change frequently, else skip.
|
Poster URL | posterUrl | string | Use this field if you want to design the QR Code with the 'Custom with Background' feature. Otherwise, skip. Enter the URL of the image you want as a background image. Tip: Ensure the image source allows cross-domain access. Or simply use the Media feature to upload image and get URL.
|
Poster Left | posterLeft | integer | Parameter valid only if poster.url is specified. This parameter will help you position the QR Code from the left edge of the uploaded background image. Specify value in percentage (%) where value is the distance between the left-edge of the image and the centre of the QR Code.Tip: Value 50 is placing the QR Code in the centre of the background image in terms of image width.
|
Poster Top | posterTop | integer | Parameter valid only if poster.url is specified. This parameter will help you position the QR Code from the top edge of the uploaded background image. Specify value in percentage (%) where value is the distance between the top-edge of the image and the centre of the QR Code.Tip: Value 50 is placing the QR Code in the centre of the background image in terms of image height.
|
Poster Size | posterSize | integer | Parameter valid only if poster.url is specified. This parameter will help you specify the size of the QR Code relative to the size of the uploaded background image. Specify value in percentage (%) where value is the ratio of QR Code size and Uploaded Image size.
|
Poster Eye Shape | posterEyeshape | string | Select a value from the drop down menu:RECT_RECT ROUND_RECT RECT_CIRC ROUNDRECT_CIRC CIRC_CIRC BR_LEAF TR_LEAF BL_LEAF TL_LEAF TLBR_LEAF TRBL_LEAF TRBL_LEAF_CIRC TLBR_LEAF_CIRC TRBL_LEAF_DIAD RECT_DIAD UNI_LEAF BLOAT_RECT WARP_RECT0 CURVE_RECT DIST_RECT ZIGZAG WARP_RECT1 BLACK_HOLE STAR GRID SCION OCTAGON FLOWER HUT DARK_HUT |
Poster Data Pattern | posterDataPattern | string | Select a value from the drop down menu:ROUND SQUARE DIAMONDS OVAL |
Format | format | string | Select a value from the drop down menu:png jpg svg pdf eps |
N/A | syncDir | dir | This component uses dir to share files between component executions. |
Email Address | address | string | The email address you want to encode in the QR Code.
|