DoneJS StealJS jQuery++ FuncUnit DocumentJS
3.14.1
5.0.0 4.3.0 2.3.35
  • About
  • Guides
  • API Docs
  • Community
  • Contributing
  • Bitovi
    • Bitovi.com
    • Blog
    • Design
    • Development
    • Training
    • Open Source
    • About
    • Contact Us
  • About
  • Guides
  • API Docs
    • Observables
      • can-compute
      • can-define
      • can-define/list/list
      • can-define/map/map
        • events
          • __keys
          • propertyName
        • static
          • extend
          • seal
        • prototype
          • assign
          • assignDeep
          • forEach
          • get
          • on
          • serialize
          • set
          • update
          • updateDeep
          • *
      • can-define-stream
      • can-define-stream-kefir
      • can-event
      • can-event/async/async
      • can-event/batch/batch
      • can-event/lifecycle/lifecycle
      • can-kefir
      • can-list
      • can-map
      • can-map-backup
      • can-map-define
      • can-observation
      • can-observe
      • can-simple-map
      • can-simple-observable
      • can-stream
      • can-stream-kefir
    • Data Modeling
      • can-connect
      • can-connect-cloneable
      • can-connect-feathers
      • can-connect-ndjson
      • can-connect-signalr
      • can-fixture
      • can-fixture-socket
      • can-ndjson-stream
      • can-set
    • Views
      • can-component
      • can-ejs
      • can-element
      • can-react-component
      • can-stache
      • can-stache/helpers/route
      • can-stache-bindings
      • can-stache-converters
      • can-view-autorender
      • can-view-callbacks
      • can-view-href
      • can-view-import
      • can-view-live
      • can-view-model
      • can-view-nodelist
      • can-view-parser
      • can-view-scope
      • can-view-target
      • react-view-model
      • react-view-model/component
      • steal-stache
    • Routing
      • can-deparam
      • can-param
      • can-route
      • can-route-pushstate
    • JS Utilities
      • can-assign
      • can-define-lazy-value
      • can-globals
      • can-key-tree
      • can-make-map
      • can-parse-uri
      • can-string
      • can-string-to-any
      • can-util
      • can-zone
      • can-zone-storage
    • DOM Utilities
      • can-ajax
      • can-attribute-encoder
      • can-control
      • can-dom-events
      • can-event-dom-enter
      • can-event-dom-radiochange
      • can-jquery
    • Data Validation
      • can-define-validate-validatejs
      • can-validate
      • can-validate-interface
      • can-validate-legacy
      • can-validate-validatejs
    • Typed Data
      • can-cid
      • can-construct
      • can-construct-super
      • can-namespace
      • can-reflect
      • can-reflect-promise
      • can-types
    • Polyfills
      • can-symbol
      • can-vdom
    • Core
    • Infrastructure
      • can-global
      • can-test-helpers
    • Ecosystem
    • Legacy
  • Community
  • Contributing
  • GitHub
  • Twitter
  • Chat
  • Forum
  • News
Bitovi

on

  • Edit on GitHub

Add event handlers to a map.

map.on(eventType, handler)

Listens to eventType on map and calls handler when the event is dispatched. This is simply a reference to can-event.on as all of can-event methods are available on DefineMap.

var map = new DefineMap({name: "Justin"})
map.on("name", function(ev, newVal, oldVal){
    newVal //-> "Brian"
    oldVal //-> "Justin"
});
map.name = "Brian";

Parameters

  1. eventType {String}:

    The type of event to bind this handler to.

  2. handler {function(event, args...)}:

    The handler to be called when this type of event fires The signature of the handler depends on the type of event being bound. See below for details.

Returns

{can-define/map/map}:

This map, for chaining.

Use

on binds event handlers to property changes on DefineMaps. When you change a property value, a property name event is fired, allowing other parts of your application to map the changes to the object.

This event is useful for noticing changes to a specific property.

var o = new DefineMap({name: "Justin"});
o.on('name', function(ev, newVal, oldVal) {
    console.log('The value of a changed.');
});

The parameters of the event handler for the property name event are:

  • ev The event object.
  • newVal The value of the property after the change. `
  • oldVal The value of the property before the change.

Here is a concrete tour through the property name event handler's arguments:

var o = new DefineMap({a: undefined, b: undefined});
o.on('a', function(ev, newVal, oldVal) {
    console.log(newVal + ', ' + oldVal);
});

o.a = 'Alexis';       // Alexis, undefined
o.set('a', 'Adam');   // Adam, Alexis
o.set({
    'a': 'Alice',     // Alice, Adam
    'b': 'Bob'
});
o.a = undefined;      // undefined, Alice

CanJS is part of DoneJS. Created and maintained by the core DoneJS team and Bitovi. Currently 3.14.1.

On this page

Get help

  • Chat with us
  • File an issue
  • Ask questions
  • Read latest news