API Docs for: 3.8.0
Show:

Record Class

Defined in: recordset/js/record.js:1
Module: queue-promote

Provides a wrapper around a standard javascript object. Can be inserted into a Recordset instance.

Item Index

Methods

Attributes

Methods

getValue

(
  • field
)
public

Defined in recordset/js/record.js:17

Retrieve a particular (or all) values from the object

Parameters:

  • field String

    (optional) The key to retrieve the value from. If not supplied, the entire object is returned.

Attributes

data

Object

Defined in recordset/js/record.js:46

The object stored within the record instance

Fires event dataChange

Fires when the value for the configuration attribute data 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.

id

String

Defined in recordset/js/record.js:37

Unique ID of the record instance

Fires event idChange

Fires when the value for the configuration attribute id 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.