Fork me on GitHub
Show:

LimitedCollection

Extends aeris.Collection
Defined in: ../src/limitedcollection.js:7

Summary

Maintains a version of a source collection which is limited to a specified length.

Constructor

aeris.LimitedCollection

Defined in ../src/limitedcollection.js:7

Syntax

aeris.LimitedCollection

(
  • options.sourceCollection
  • options.limit
)

Summary

Parameters:

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

Inherited from Backbone.Collection: ../src/collection.js:159

Syntax

add

(
  • models
)

Summary

Add models to the collection.

Parameters:

at

Inherited from aeris.Collection: ../src/collection.js:113

Syntax

at

(
  • index
)
Model

Summary

Retrieve a model from the collection by index.

Parameters:

Returns:

Model:

bindToSourceCollection_

Defined in ../src/limitedcollection.js:77

Syntax

bindToSourceCollection_

() private

Summary

enforceLimit_

Defined in ../src/limitedcollection.js:88

Syntax

enforceLimit_

() private

Summary

getSourceCollection

Defined in ../src/limitedcollection.js:145

Syntax

getSourceCollection

() Collection

Summary

Returns:

Collection:

getSourceLength

Defined in ../src/limitedcollection.js:136

Syntax

getSourceLength

() Number

Summary

Returns:

Number:

getSourceModels_

Defined in ../src/limitedcollection.js:99

Syntax

getSourceModels_

(
  • count
)
Array.<model> private

Summary

Parameters:

  • count Number

    Number of source models to retrieve.

Returns:

Array.<model>:

isValid

Inherited from aeris.Collection: ../src/collection.js:88

Syntax

isValid

() Boolean=

Summary

Runs validation on all collection models.

Returns:

Boolean=:

Returns false if any model fails validation.

parse

Inherited from Backbone.Collection: ../src/collection.js:211

Syntax

parse

() protected

Summary

pop

Inherited from Backbone.Collection: ../src/collection.js:190

Syntax

pop

() protected

Summary

push

Inherited from Backbone.Collection: ../src/collection.js:185

Syntax

push

() protected

Summary

remove

Inherited from Backbone.Collection: ../src/collection.js:166

Syntax

remove

(
  • models
)

Summary

Remove models from the collection.

Parameters:

reset

Inherited from Backbone.Collection: ../src/collection.js:173

Syntax

reset

(
  • opt_models
)

Summary

Remove and replace all models in the collection.

Parameters:

set

Inherited from Backbone.Collection: ../src/collection.js:180

Syntax

set

() protected

Summary

shift

Inherited from Backbone.Collection: ../src/collection.js:195

Syntax

shift

() protected

Summary

slice

Inherited from Backbone.Collection: ../src/collection.js:200

Syntax

slice

() protected

Summary

validateConstructorParams_

Defined in ../src/limitedcollection.js:51

Syntax

validateConstructorParams_

(
  • opt_models
  • options
)
protected static

Summary

Parameters:

validateModel_

Defined in ../src/limitedcollection.js:122

Syntax

validateModel_

(
  • model
)
private

Summary

Parameters:

Properties

length

Inherited from Backbone.Collection: ../src/collection.js:205

Syntax

length

Unknown

Summary

The number of models in the collection.

limit_

Defined in ../src/limitedcollection.js:34

Syntax

limit_

Number private

Summary

model

Inherited from Backbone.Collection: ../src/collection.js:154

Syntax

model

Function

Summary

modelOptions_

Inherited from aeris.Collection: ../src/collection.js:33

Syntax

modelOptions_

Object protected

Summary

Options to pass on to models created by this collection.

sourceCollection_

Defined in ../src/limitedcollection.js:26

Syntax

sourceCollection_

aeris.Collection private

Summary

Events

add

Inherited from aeris.Collection: ../src/collection.js:67

Syntax

add

Summary

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

Event Payload:

change

Inherited from aeris.Collection: ../src/collection.js:52

Syntax

change

Summary

When any child model's attribute changes

Event Payload:

change:[attribute]

Inherited from aeris.Collection: ../src/collection.js:58

Syntax

change:[attribute]

Summary

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

Event Payload:

remove

Inherited from aeris.Collection: ../src/collection.js:76

Syntax

remove

Summary

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

Event Payload: