Fork me on GitHub
Show:

ViewCollection

Extends aeris.Collection
Defined in: ../src/viewcollection.js:6

Summary

A representation of a data collection, which has been reshaped into a form expected by a view.

Constructor

aeris.util.aeris.ViewCollection

Defined in ../src/viewcollection.js:6

Syntax

aeris.util.aeris.ViewCollection

()

Summary

Methods

addViewModel_

Defined in ../src/viewcollection.js:111

Syntax

addViewModel_

(
  • dataModel
)
private

Summary

Add a view model.

Parameters:

  • dataModel Model

    The data model to associate with the view model.

bindToDataCollection_

Defined in ../src/viewcollection.js:80

Syntax

bindToDataCollection_

() private

Summary

createViewModel_

Defined in ../src/viewcollection.js:176

Syntax

createViewModel_

(
  • dataModel
)
ViewModel protected

Summary

Create a view model, associated with a specified data model.

Parameters:

Returns:

ViewModel:

fetchData

Defined in ../src/viewcollection.js:203

Syntax

fetchData

(
  • opt_options
)
Promise

Summary

Parameters:

  • opt_options Object=

    Options to pass to aeris.Model#fetch.

Returns:

Promise:

getData

Defined in ../src/viewcollection.js:194

Syntax

getData

() Collection

Summary

Returns:

Collection:

proxyDataSyncEvents_

Defined in ../src/viewcollection.js:95

Syntax

proxyDataSyncEvents_

() private

Summary

removeViewModel_

Defined in ../src/viewcollection.js:127

Syntax

removeViewModel_

(
  • dataModel
)
private

Summary

Remove a view model.

Parameters:

  • dataModel Model

    The associated data model.

updateModelsFromData_

Defined in ../src/viewcollection.js:149

Syntax

updateModelsFromData_

() private

Summary

Reset view models, to sync up with our data model.

Properties

data_

Defined in ../src/viewcollection.js:30

Syntax

data_

aeris.Collection private

Summary

Data collection.

viewModelLookup_

Defined in ../src/viewcollection.js:40

Syntax

viewModelLookup_

Object. private

Summary

A cache of created view model instances, referenced by their associated data model cid.

Events

data:request

Defined in ../src/viewcollection.js:53

Syntax

data:request

Summary

The bound data collection has made an API request.

Event Payload:

  • viewCollection aeris.ViewCollection
  • promiseToSync aeris.Promise

    Resolves with raw API response data.

data:sync

Defined in ../src/viewcollection.js:60

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:

  • viewCollection aeris.ViewCollection
  • responseData Object

    Raw API response data.