Fork me on GitHub
Show:

ViewModel

Extends aeris.Model
Defined in: ../src/viewmodel.js:6

Summary

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

Inspired by https://github.com/tommyh/backbone-view-model

Constructor

aeris.ViewModel

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

Syntax

aeris.ViewModel

(
  • opt_attrs
  • opt_options
)

Summary

Parameters:

Methods

bindAttributesTo

Inherited from aeris.Model: ../src/model.js:226

Syntax

bindAttributesTo

(
  • target
  • attrs
)

Summary

Keep this model updated with values from the target model.

Immediately updates the model with the specified attributes, and updates this model whenever the target model's attributes change.

Parameters:

clone

Inherited from aeris.Model: ../src/model.js:210

Syntax

clone

(
  • opt_attrs
  • opt_options
)
Model

Summary

Create a copy of the model.

Parameters:

  • opt_attrs Object=

    Attributes to set on the cloned model.

  • opt_options Object=

    Options to pass to cloned mode.

Returns:

Model:

destroy

Defined in ../src/viewmodel.js:135

Syntax

destroy

()

Summary

fetch

Inherited from Backbone.Model: ../src/model.js:368

Syntax

fetch

()

Summary

Fetch model data.

fetchData

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

Syntax

fetchData

(
  • opt_options
)
Promise

Summary

Invoke the 'fetch' method on our data model.

Parameters:

  • opt_options Object=

    Options to pass to the aeris.Model#fetch method.

Returns:

Promise:

get

Inherited from Backbone.Model: ../src/model.js:291

Syntax

get

(
  • attribute
)
* protected

Summary

Parameters:

Returns:

*:

getAtPath

Inherited from aeris.Model: ../src/model.js:180

Syntax

getAtPath

(
  • path
)
*|undefined

Summary

Returns a deep-nested property of a model attribute.

Example: model.set('deepObj', { levelA: { levelB: { foo: 'bar' } } });

model.getAtPath('deepObj.levelA.levelB.foo'); // 'bar'

Returns undefined if the path cannot be resolved.

Parameters:

Returns:

*|undefined:

getData

Defined in ../src/viewmodel.js:90

Syntax

getData

() Model

Summary

Returns:

Model:

The data model associated with this view model.

getDataAttribute

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

Syntax

getDataAttribute

(
  • path
)
String

Summary

Returns an attribute of the data model at a given path.

Parameters:

Returns:

String:

has

Inherited from Backbone.Model: ../src/model.js:308

Syntax

has

() Boolean protected

Summary

Returns:

Boolean:

isValid

Inherited from aeris.Model: ../src/model.js:120

Syntax

isValid

()

Summary

Validate the model's attributes.

normalize_

Inherited from aeris.Model: ../src/model.js:162

Syntax

normalize_

(
  • attrs
)
Attrs protected

Summary

This method is called every time attributes are set on the model.

Override to provide any additional processing needed for options object structure, etc.

Parameters:

Returns:

Attrs:

Normalized attrs.

off

Inherited from aeris.Events: ../src/events.js:58

Syntax

off

()

Summary

See http://backbonejs.org/#Events-off

on

Inherited from aeris.Events: ../src/events.js:37

Syntax

on

()

Summary

Bind an event handler to the object. See Backbone.Events#on

onValidationError_

Inherited from aeris.Model: ../src/model.js:107

Syntax

onValidationError_

(
  • model
  • error
)
private

Summary

Handle 'invalid' events thrown by the model.

Parameters:

parse

Inherited from Backbone.Model: ../src/model.js:379

Syntax

parse

() protected

Summary

Inherited from Backbone.Model: ../src/model.js:320

Syntax

() protected

Summary

proxyEvents

Inherited from aeris.Events: ../src/events.js:80

Syntax

proxyEvents

(
  • obj
  • =}
  • opt_ctx
)
protected

Summary

Proxies all events from another {aeris.Event} object. In other words, all the events that you trigger, I'm gonna trigger too.

Passes along the original object as the first argument when triggering proxied events.

Parameters:

  • obj Events=

    The object to proxy.

  • =} Function(string, Array):Object

    opt_callback A callback function to customize the proxied event. Should return on object with 'topic' and 'args' properties.

       Example:
     parent.proxy(child, function(topic, args) {
       return {
         topic: 'child:' + topic,
         args: [child].concat(args)
       }
     });

   ...would trigger all child events, with a topic prepended
   with 'child:', and with the child object inserted as the first
   argument.
  • opt_ctx Object=

    A context in which to call the opt_callback function. Defaults to this.

removeProxy

Inherited from aeris.Events: ../src/events.js:134

Syntax

removeProxy

() protected

Summary

End any proxies that have been wrapped around this {Events} object.

set

Inherited from Backbone.Model but overwritten in ../src/model.js:129

Syntax

set

(
  • config
)
protected

Summary

Normalize attributes before setting

Parameters:

sync

Inherited from Backbone.Model but overwritten in ../src/model.js:360

Syntax

sync

(
  • method
  • model
  • options
)
protected

Summary

Parameters:

syncToModel

Defined in ../src/viewmodel.js:74

Syntax

syncToModel

()

Summary

Uses attribute transforms to sync the view model to the data model.

toJSON

Inherited from Backbone.Model: ../src/model.js:355

Syntax

toJSON

() Object

Summary

Returns:

Object:

A shallow copy of the model's attributes.

unset

Inherited from Backbone.Model: ../src/model.js:314

Syntax

unset

(
  • attribute
)
protected

Summary

Parameters:

updateWithAttributesOf_

Inherited from aeris.Model: ../src/model.js:252

Syntax

updateWithAttributesOf_

(
  • target
  • attrs
)
private

Summary

Update the attributes of the model with attributes from another model.

Parameters:

validate

Inherited from Backbone.Model: ../src/model.js:374

Syntax

validate

() protected

Summary

Properties

attributes

Inherited from Backbone.Model: ../src/model.js:343

Syntax

attributes

Object protected

Summary

attributeTransforms_

Defined in ../src/viewmodel.js:41

Syntax

attributeTransforms_

Object. private

Summary

A hash of transforms to apply to attributes.

Example: { km: function() { return this.getData().get('miles') * 1.609344; } }

this.getData().set('miles', 3.0); this.get('km'); // 4.82803

cid

Inherited from Backbone.Model: ../src/model.js:337

Syntax

cid

Number | String protected

Summary

data_

Defined in ../src/viewmodel.js:31

Syntax

data_

aeris.Model private

Summary

Data model.

defaults

Inherited from Backbone.Model but overwritten in ../src/model.js:42

Syntax

defaults

Unknown

Summary

id

Inherited from Backbone.Model: ../src/model.js:331

Syntax

id

Number | String protected

Summary

idAttribute

Inherited from Backbone.Model but overwritten in ../src/model.js:36

Syntax

idAttribute

Unknown

Summary

options_

Inherited from aeris.Model: ../src/model.js:48

Syntax

options_

Object private

Summary

The options used when constructing the model.

Events

add

Inherited from aeris.Model: ../src/model.js:85

Syntax

add

Summary

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

Event Payload:

change

Inherited from aeris.Model: ../src/model.js:70

Syntax

change

Summary

When a model's attribute changes

Event Payload:

change:[attribute]

Inherited from aeris.Model: ../src/model.js:76

Syntax

change:[attribute]

Summary

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

Event Payload:

remove

Inherited from aeris.Model: ../src/model.js:94

Syntax

remove

Summary

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

Event Payload: