API Docs for: 0.1.0
Show:

Collection Class

Defined in: js/types/collection.js:19

Constructor

Collection

(
  • [options]
)

Defined in js/types/collection.js:19

Parameters:

  • [options] Object optional

    configuration object

    • [min] Number optional

      min default min items

    • [max] Number optional

      max default max items

    • [singleValue] String optional

      singleValue property name of single value

Methods

addChild

(
  • index
  • item
  • template
  • propertyName
)
Object

Defined in js/types/collection.js:102

add a child to this.$el but on

Parameters:

  • index Number

    for resulting $item dom element

  • item Object

    data for resulting $item dom element

  • template String

    to render $item

  • propertyName String

    name of property

Returns:

Object:

deferred objects that´s indicates end of asynchronous functions

canAdd

() Boolean

Defined in js/types/collection.js:249

returns TRUE if a child can be added for given property

Returns:

Boolean:

canRemove

() Boolean

Defined in js/types/collection.js:259

returns TRUE if a child can be removed for given property

Returns:

Boolean:

getChildren

(
  • propertyName
)
Array

Defined in js/types/collection.js:219

returns children for given property

Parameters:

  • propertyName String

Returns:

Array:

getMaxOccurs

(
  • propertyName
)
Number

Defined in js/types/collection.js:239

returns min occurs

Parameters:

  • propertyName String

Returns:

Number:

getMinOccurs

(
  • propertyName
)
Number

Defined in js/types/collection.js:229

returns min occurs

Parameters:

  • propertyName String

Returns:

Number:

getValue

(
  • propertyName
  • returnMapperId
)
Array

Defined in js/types/collection.js:171

returns data array

Parameters:

  • propertyName String
  • returnMapperId String

Returns:

Array:

initializeSub

()

Defined in js/types/collection.js:43

initialize templates

internalSetValue

(
  • templates
  • value
  • propertyName
)
Object

Defined in js/types/collection.js:68

maps given array (value) with given templates to this.$el

Parameters:

  • templates Object

    includes tpl and empty template

  • value Array

    array of data

  • propertyName String

    name of property

Returns:

Object:

deferred objects that´s indicates end of asynchronous functions

needsValidation

() Boolean

Defined in js/types/collection.js:210

indicates data to validate

Returns:

Boolean:

setValue

(
  • data
  • propertyName
)
Object

Defined in js/types/collection.js:150

map value to this.$el

Parameters:

  • data Array
  • propertyName String

Returns:

Object:

deferred objects that´s indicates end of asynchronous functions

validate

() Boolean

Defined in js/types/collection.js:201

validates this type of data

Returns:

Boolean: