SubsetCollection
Summary
A collection which acts as a subset of another (source) collection.
A SubsetCollection defines rules for filtering models from a source collection. The SubsetCollection will sync to all changes in the source collection. If filtered rules are changed on the SubsetCollection, it will be updated with models from the soure collection accordingly
Constructor
Item Index
Methods
Properties
Events
Methods
_prepareModel
Syntax
_prepareModel
()
private
Summary
Pass modelOptions on to newly created models.
add
Syntax
add
-
models
Summary
Add models to the collection.
Parameters:
-
modelsArray.<Backbone.Model|Object>
bindToSourceCollection_
Syntax
bindToSourceCollection_
()
private
Summary
fetch
Syntax
Summary
Fetches data from the underlying source collection.
Parameters:
-
opt_optionsObject=
Returns:
getFilteredSourceModels_
Syntax
Summary
isUnderLimit
Syntax
Summary
Does the collection have fewer models than the specified limit?
If no limit is set, this will always return true.
Returns:
isValid
Syntax
Summary
Runs validation on all collection models.
Returns:
Returns false if any model fails validation.
normalizeSourceCollection_
Syntax
normalizeSourceCollection_
()
private
Summary
parse
Syntax
parse
()
protected
Summary
pop
Syntax
pop
()
protected
Summary
proxyRequestEvents_
Syntax
proxyRequestEvents_
()
private
Summary
push
Syntax
push
()
protected
Summary
remove
Syntax
remove
-
models
Summary
Remove models from the collection.
Parameters:
-
modelsArray.<Backbone.Model>
removeFilter
Syntax
removeFilter
()
Summary
Stops filtering models from the source collection.
removeLimit
Syntax
removeLimit
()
Summary
Stops limiting the number of models from the source collection to set on the SubsetCollection.
reset
Syntax
reset
-
opt_models
Summary
Remove and replace all models in the collection.
Parameters:
-
opt_modelsArray.<Backbone.Model|Object>=
resetToSourceModel_
Syntax
resetToSourceModel_
()
private
Summary
set
Syntax
set
()
protected
Summary
setFilter
Syntax
setFilter
-
filter -
opt_ctx
Summary
Sets a filter to be used when syncing the SubsetCollection to it's source collection.
The filter receives a source collection models as an argument. If the filter returns true, the model will be added to the SubsetCollection.
Set the filter to null to disable filtering.
setLimit
Syntax
setLimit
-
limit
Summary
Limits the number of models from the source collection to set on the SubsetCollection.
Parameters:
-
limitNumber
shift
Syntax
shift
()
protected
Summary
slice
Syntax
slice
()
protected
Summary
Properties
filter_
Syntax
filter_
?function():Boolean
private
Summary
length
Syntax
length
Unknown
Summary
The number of models in the collection.
limit_
Syntax
limit_
?number If null, no limit is enforced.
protected
Summary
modelOptions_
Syntax
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:
-
modelaeris.Model -
collectionaeris.Collection
change
Syntax
change
Summary
When any child model's attribute changes
Event Payload:
-
modelaeris.Model
change:[attribute]
Syntax
change:[attribute]
Summary
When any child model's attribute changes, where [attribute] is the name of the attribute.
Event Payload:
-
modelaeris.Model -
value
remove
Syntax
remove
Summary
When a model is removed from the {aeris.Collection}.
Event Payload:
-
modelaeris.Model -
collectionaeris.Collection