ViewCollection
Summary
A representation of a data collection, which has been reshaped into a form expected by a view.
Constructor
aeris.ViewCollection
Syntax
aeris.ViewCollection
()
Summary
Item Index
Methods
Properties
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>
addViewModel_
Syntax
addViewModel_
-
dataModel
Summary
Add a view model.
Parameters:
-
dataModelModelThe data model to associate with the view model.
bindToDataCollection_
Syntax
bindToDataCollection_
()
private
Summary
createViewModel_
Syntax
Summary
Create a view model, associated with a specified data model.
Parameters:
-
dataModelModel
Returns:
fetchData
Syntax
Summary
Parameters:
-
opt_optionsObject=Options to pass to aeris.Model#fetch.
Returns:
isValid
Syntax
Summary
Runs validation on all collection models.
Returns:
Returns false if any model fails validation.
parse
Syntax
parse
()
protected
Summary
pop
Syntax
pop
()
protected
Summary
proxyDataSyncEvents_
Syntax
proxyDataSyncEvents_
()
private
Summary
push
Syntax
push
()
protected
Summary
remove
Syntax
remove
-
models
Summary
Remove models from the collection.
Parameters:
-
modelsArray.<Backbone.Model>
removeViewModel_
Syntax
removeViewModel_
-
dataModel
Summary
Remove a view model.
Parameters:
-
dataModelModelThe associated data model.
reset
Syntax
reset
-
opt_models
Summary
Remove and replace all models in the collection.
Parameters:
-
opt_modelsArray.<Backbone.Model|Object>=
set
Syntax
set
()
protected
Summary
shift
Syntax
shift
()
protected
Summary
slice
Syntax
slice
()
protected
Summary
updateModelsFromData_
Syntax
updateModelsFromData_
()
private
Summary
Reset view models, to sync up with our data model.
Properties
length
Syntax
length
Unknown
Summary
The number of models in the collection.
modelOptions_
Syntax
Summary
Options to pass on to models created by this collection.
viewModelLookup_
Syntax
viewModelLookup_
Object.Summary
A cache of created view model instances, referenced by their associated data model cid.
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
data:request
Syntax
data:request
Summary
The bound data collection has made an API request.
Event Payload:
-
viewCollectionaeris.ViewCollection -
promiseToSyncaeris.PromiseResolves with raw API response data.
data:sync
Syntax
data:sync
Summary
The data API has responded to a request, and the view collection's bound data object has been updated with fetched data.
Event Payload:
-
viewCollectionaeris.ViewCollection -
responseDataObjectRaw API response data.
remove
Syntax
remove
Summary
When a model is removed from the {aeris.Collection}.
Event Payload:
-
modelaeris.Model -
collectionaeris.Collection