UI Flows
QrCode: Component to render a QR Code.
Parameters:
Name
Type**
Mandatory
MainSettings
QrCodeMainSettings
YES
LogoSettings
QrCodeLogoSettings
NO
QrEngineSettings
QrCodeEngineSettings
ContentSettings
QrCodeContentSettings
BackgroudSettings
QrCodeBackgroudSettings
CornerOuterSettings
QrCodeCornerOuterSettings
CornerInnerSettings
QrCodeCornerInnerSettings
** For the specification check the Structures section on this documentation.
Ui settings related to the background.
Attribute
Description
Type
Color
Color Hex Value. To Set Backgroupd to transpent use #FFFFFF00
Text
Gradient
Gradient Settings
QrCodeStyleGradient
Ui settings related to external corner of the qr code.
Color Hex Value
Style of QR outer corner
QrCornerOuterRenderOptionSet Identifier
Ui settings related to main part of the qr code.
QrContentRenderOptionSet Identifier
Ui settings related to external inner corner of the qr code.
QrCornerInnerRenderOptionSet Identifier
Settings related to generator engine.
SymbolVersion
The version to use for qr content generator. The symbol versions of QR Code range from Version 1 to Version 40, if 0 (default value) is used the engine auto compute the correct version
Integer
EncodingMode
The Encoding Mode used by engine to analyze the payload and generate the qr code
QrCodeEncodingPatterns Identifier
ErrorCorrectionLevel
There are 4 error correction levels used for QR codes, with each one adding different amounts of "backup" data depending on how much damage the QR code is expected to suffer in its intended environment, and hence how much error correction may be required:
Level L - up to 7% damage
Level M - up to 15% damage
Level Q - up to 25% damage
Level H - up to 30% damage
QrErrorCorrectionLevel Identifier
Logo defintion to use for image rendering. IMPORTANT:
The logo definition support both Image Binary or an image url. But the image binary has a higher priority so if the binary is present the url is ignored.
Tip: set always an image url as a fallback image.
Binary
The image binary data
Binary Data
ImageType
The type of image "png,jpeg,etc...."
ImageUrl
The url of the image
Ui settings related to central logo.
HideBackGroundContent
Hide all qr content covered by the image
LogoCoefficientSize
Coefficient of the image size. Not recommended to use over 0.5. Lower is better
Decimal
Margin
Margin of the logo in px
Ui settings related to the qr code.
HeightPixel
Height of qr
WidthPixel
Width of qr
The margin between qr code and its container
Payload
The data to encode into the QR code
Logo
The image at the center of the qr
QrCodeLogo
RenderMode
The type of the element that will be rendered
QrRenderMode Identifier
Ui settings related to gradient.
Mode
Type of gradient
QrCodeStyleGradientMode Identifier
Rotation
Rotation of gradient in radians
Colors
Gradient colors.
QrCodeStyleGradientColor List
Ui style related to the gradient
Offset
Position of color in gradient range. The value must be in the following range ( 0.0 <-> 1.0 )
QrCodeAllowedExtensions (Public)
The allowed extensions to download/transform the qr code.
QrCodeEncodingPatterns (Public)
The encoding alg to be used by the generator engine.
QrCodeStyleGradientMode (Public)
Type of gradient to use in the qr code.
QrContentRenderOptionSet (Public)
Ui style used by the main central part of the qr code.
QrCornerInnerRenderOptionSet (Public)
Ui style used by the external inner corner part of the qr code.
QrCornerOuterRenderOptionSet (Public)
Ui style used by the external corner part of the qr code.
QrErrorCorrectionLevel (Public)
The correction level used by the generator engine.
QrRenderMode (Public)
Settings to specific the html object to render.
Public client action to download as image or svg the qr code.
DataType
QrCodeBlockId
The Qr Code Widget Id
FileName
The name without extension used to save the file
Extension
The extension of the image ( ie: png).
QrCodeAllowedExtensions Identifier
Public client action to retrieve the qr code image binary data, usefull to save it into the database.
BinaryData
ModuleCount
The module total count.