API Docs for:
Show:

QrCode.Data Class

This class shouldn't be used directly. It is intended as an interface to implement a specific data encoding mode.

Constructor

QrCode.Data

(
  • config
)

Parameters:

  • config Object

    Configuration object.

Item Index

Methods

Properties

Attributes

Methods

toBinaryString

(
  • version
)
String

This is an abstract method that should be implemented to return a properly formatted binary string for a specific data encoding mode.

Parameters:

Returns:

Properties

Type

[String] static

This object lists all supported data encoding modes.

Attributes

type

String

When extending this class, the value of type should be specifically defined. Make sure the type is also set on the Y.QrCode.Data.Type object.

Fires event typeChange

Fires when the value for the configuration attribute type is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

value

The value to encode.

Fires event valueChange

Fires when the value for the configuration attribute value is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.