Fork me on GitHub
Show:

Collection

Summary

Base collection class.

Constructor

aeris.Collection

Syntax

aeris.Collection

(
  • opt_models
  • opt_options
)

Summary

Parameters:

  • opt_models Array.<Model>=
  • opt_options Object
    • validate Boolean=

      If set to true, will validate all models on instantiation.

Methods

_prepareModel

Inherited from Backbone.Collection but overwritten in ../src/collection.js:122

Syntax

_prepareModel

() private

Summary

Pass modelOptions on to newly created models.

add

Syntax

add

(
  • models
)

Summary

Add models to the collection.

Parameters:

at

Syntax

at

(
  • index
)
Model

Summary

Retrieve a model from the collection by index.

Parameters:

Returns:

isValid

Syntax

isValid

() Boolean=

Summary

Runs validation on all collection models.

Returns:

Boolean=:

Returns false if any model fails validation.

parse

Syntax

parse

() protected

Summary

pop

Syntax

pop

() protected

Summary

push

Syntax

push

() protected

Summary

remove

Syntax

remove

(
  • models
)

Summary

Remove models from the collection.

Parameters:

reset

Syntax

reset

(
  • opt_models
)

Summary

Remove and replace all models in the collection.

Parameters:

set

Syntax

set

() protected

Summary

shift

Syntax

shift

() protected

Summary

slice

Syntax

slice

() protected

Summary

Properties

length

Syntax

length

Unknown

Summary

The number of models in the collection.

model

Syntax

model

Function

Summary

modelOptions_

Syntax

modelOptions_

Object protected

Summary

Options to pass on to models created by this collection.

Events

add

Syntax

add

Summary

When a model is added to the {aeris.Collection}.

Event Payload:

change

Syntax

change

Summary

When any child model's attribute changes

Event Payload:

change:[attribute]

Syntax

change:[attribute]

Summary

When any child model's attribute changes, where [attribute] is the name of the attribute.

Event Payload:

remove

Syntax

remove

Summary

When a model is removed from the {aeris.Collection}.

Event Payload: