cartodb/Backbone.Undo.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added a code example to the description of 'on' in the UndoTypes section

Browse Source
This commit is contained in:
Oliver Sartun 2013-10-24 19:12:38 +02:00
parent 0288f4569f
commit c199856d24
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -218,6 +218,14 @@ An *UndoType* needs to have the following functions:
* **on** `([…])`
This function is called when the event this UndoType is made for was triggered on an observed object. It gets all the arguments that were triggered with the event. The `on`-function must return an object with the properties `object`, `before`, `after` and optionally `options`.
return {
"object": … // The object the event was triggered on
"before": … // The object's state before the concerning action occured
"after": … // The object's current state, after the concerning action occured
"options": … // Optionally: Some 'options'-object
}
* **undo** `(obj, before, after, options)`
The `undo` function is called when the action this UndoType is made for should be undone. The data returned by the `on` function is passed to `undo` as arguments:
* `obj` is the model, collection or other kind of object that should be acted on