PageRenderTime 83ms CodeModel.GetById 27ms RepoModel.GetById 1ms app.codeStats 0ms

/www/protected/extensions/admin/assets/js/libs/backbone/0.5.3-optamd3/index.html

https://bitbucket.org/badenkov/demo
HTML | 3015 lines | 2579 code | 436 blank | 0 comment | 0 complexity | b1935a4120f5910a5731dd05c890c78b MD5 | raw file
Possible License(s): Apache-2.0, MIT, LGPL-2.1, BSD-2-Clause, CC-BY-SA-3.0, BSD-3-Clause

Large files files are truncated, but you can click here to view the full file

  1. <!DOCTYPE HTML>
  2. <html>
  3. <head>
  4. <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
  5. <meta http-equiv="X-UA-Compatible" content="chrome=1">
  6. <title>Backbone.js</title>
  7. <style>
  8. body {
  9. font-size: 14px;
  10. line-height: 22px;
  11. font-family: Helvetica Neue, Helvetica, Arial;
  12. background: #f4f4f4 url(docs/images/background.png);
  13. }
  14. .interface {
  15. font-family: "Lucida Grande", "Lucida Sans Unicode", Helvetica, Arial, sans-serif !important;
  16. }
  17. div#sidebar {
  18. background: #fff;
  19. position: fixed;
  20. top: 0; left: 0; bottom: 0;
  21. width: 200px;
  22. overflow-y: auto;
  23. overflow-x: hidden;
  24. padding: 15px 0 30px 30px;
  25. border-right: 1px solid #bbb;
  26. box-shadow: 0 0 20px #ccc; -webkit-box-shadow: 0 0 20px #ccc; -moz-box-shadow: 0 0 20px #ccc;
  27. }
  28. a.toc_title, a.toc_title:visited {
  29. display: block;
  30. color: black;
  31. font-weight: bold;
  32. margin-top: 15px;
  33. }
  34. a.toc_title:hover {
  35. text-decoration: underline;
  36. }
  37. #sidebar .version {
  38. font-size: 10px;
  39. font-weight: normal;
  40. }
  41. ul.toc_section {
  42. font-size: 11px;
  43. line-height: 14px;
  44. margin: 5px 0 0 0;
  45. padding-left: 0px;
  46. list-style-type: none;
  47. font-family: Lucida Grande;
  48. }
  49. .toc_section li {
  50. cursor: pointer;
  51. margin: 0 0 3px 0;
  52. }
  53. .toc_section li a {
  54. text-decoration: none;
  55. color: black;
  56. }
  57. .toc_section li a:hover {
  58. text-decoration: underline;
  59. }
  60. div.container {
  61. position: relative;
  62. width: 550px;
  63. margin: 40px 0 50px 260px;
  64. }
  65. div.run {
  66. position: absolute;
  67. right: 15px;
  68. width: 26px; height: 18px;
  69. background: url('docs/images/arrows.png') no-repeat -26px 0;
  70. }
  71. div.run:active {
  72. background-position: -51px 0;
  73. }
  74. p, div.container ul {
  75. margin: 20px 0;
  76. width: 550px;
  77. }
  78. p.warning {
  79. font-size: 12px;
  80. line-height: 18px;
  81. font-style: italic;
  82. }
  83. div.container ul {
  84. list-style: circle;
  85. font-size: 12px;
  86. padding-left: 15px;
  87. }
  88. a, a:visited {
  89. color: #444;
  90. }
  91. a:active, a:hover {
  92. color: #000;
  93. }
  94. a img {
  95. border: 0;
  96. }
  97. h1, h2, h3, h4, h5, h6 {
  98. padding-top: 20px;
  99. }
  100. h2 {
  101. font-size: 20px;
  102. }
  103. b.header {
  104. font-size: 16px;
  105. line-height: 30px;
  106. }
  107. span.alias {
  108. font-size: 14px;
  109. font-style: italic;
  110. margin-left: 20px;
  111. }
  112. table {
  113. margin: 15px 0 0; padding: 0;
  114. }
  115. tr, td {
  116. margin: 0; padding: 0;
  117. }
  118. td {
  119. padding: 0px 15px 5px 0;
  120. }
  121. code, pre, tt {
  122. font-family: Monaco, Consolas, "Lucida Console", monospace;
  123. font-size: 12px;
  124. line-height: 18px;
  125. font-style: normal;
  126. }
  127. tt {
  128. padding: 0px 3px;
  129. background: #fff;
  130. border: 1px solid #ddd;
  131. zoom: 1;
  132. }
  133. code {
  134. margin-left: 20px;
  135. }
  136. pre {
  137. font-size: 12px;
  138. padding: 2px 0 2px 15px;
  139. border: 4px solid #bbb; border-top: 0; border-bottom: 0;
  140. margin: 0px 0 30px;
  141. }
  142. img.example_image {
  143. margin: 0px auto;
  144. }
  145. </style>
  146. </head>
  147. <body>
  148. <div id="sidebar" class="interface">
  149. <a class="toc_title" href="#">
  150. Backbone.js <span class="version">(0.5.3)</span>
  151. </a>
  152. <a class="toc_title" href="#Introduction">
  153. Introduction
  154. </a>
  155. <a class="toc_title" href="#Events">
  156. Events
  157. </a>
  158. <ul class="toc_section">
  159. <li> <a href="#Events-bind">bind</a></li>
  160. <li> <a href="#Events-unbind">unbind</a></li>
  161. <li> <a href="#Events-trigger">trigger</a></li>
  162. </ul>
  163. <a class="toc_title" href="#Model">
  164. Model
  165. </a>
  166. <ul class="toc_section">
  167. <li> <a href="#Model-extend">extend</a></li>
  168. <li> <a href="#Model-constructor">constructor / initialize</a></li>
  169. <li> <a href="#Model-get">get</a></li>
  170. <li> <a href="#Model-set">set</a></li>
  171. <li> <a href="#Model-escape">escape</a></li>
  172. <li> <a href="#Model-has">has</a></li>
  173. <li> <a href="#Model-unset">unset</a></li>
  174. <li> <a href="#Model-clear">clear</a></li>
  175. <li> <a href="#Model-id">id</a></li>
  176. <li> <a href="#Model-cid">cid</a></li>
  177. <li> <a href="#Model-attributes">attributes</a></li>
  178. <li> <a href="#Model-defaults">defaults</a></li>
  179. <li>- <a href="#Model-toJSON">toJSON</a></li>
  180. <li> <a href="#Model-fetch">fetch</a></li>
  181. <li> <a href="#Model-save">save</a></li>
  182. <li> <a href="#Model-destroy">destroy</a></li>
  183. <li> <a href="#Model-validate">validate</a></li>
  184. <li> <a href="#Model-url">url</a></li>
  185. <li> <a href="#Model-urlRoot">urlRoot</a></li>
  186. <li> <a href="#Model-parse">parse</a></li>
  187. <li> <a href="#Model-clone">clone</a></li>
  188. <li> <a href="#Model-isNew">isNew</a></li>
  189. <li> <a href="#Model-change">change</a></li>
  190. <li> <a href="#Model-hasChanged">hasChanged</a></li>
  191. <li> <a href="#Model-changedAttributes">changedAttributes</a></li>
  192. <li> <a href="#Model-previous">previous</a></li>
  193. <li> <a href="#Model-previousAttributes">previousAttributes</a></li>
  194. </ul>
  195. <a class="toc_title" href="#Collection">
  196. Collection
  197. </a>
  198. <ul class="toc_section">
  199. <li> <a href="#Collection-extend">extend</a></li>
  200. <li> <a href="#Collection-model">model</a></li>
  201. <li> <a href="#Collection-constructor">constructor / initialize</a></li>
  202. <li> <a href="#Collection-models">models</a></li>
  203. <li> <a href="#Collection-toJSON">toJSON</a></li>
  204. <li> <a href="#Collection-Underscore-Methods"><b>Underscore Methods (26)</b></a></li>
  205. <li> <a href="#Collection-add">add</a></li>
  206. <li> <a href="#Collection-remove">remove</a></li>
  207. <li> <a href="#Collection-get">get</a></li>
  208. <li> <a href="#Collection-getByCid">getByCid</a></li>
  209. <li> <a href="#Collection-at">at</a></li>
  210. <li> <a href="#Collection-length">length</a></li>
  211. <li> <a href="#Collection-comparator">comparator</a></li>
  212. <li> <a href="#Collection-sort">sort</a></li>
  213. <li> <a href="#Collection-pluck">pluck</a></li>
  214. <li> <a href="#Collection-url">url</a></li>
  215. <li> <a href="#Collection-parse">parse</a></li>
  216. <li> <a href="#Collection-fetch">fetch</a></li>
  217. <li> <a href="#Collection-reset">reset</a></li>
  218. <li> <a href="#Collection-create">create</a></li>
  219. </ul>
  220. <a class="toc_title" href="#Router">
  221. Router
  222. </a>
  223. <ul class="toc_section">
  224. <li> <a href="#Router-extend">extend</a></li>
  225. <li> <a href="#Router-routes">routes</a></li>
  226. <li> <a href="#Router-constructor">constructor / initialize</a></li>
  227. <li> <a href="#Router-route">route</a></li>
  228. <li> <a href="#Router-navigate">navigate</a></li>
  229. </ul>
  230. <a class="toc_title" href="#History">
  231. History
  232. </a>
  233. <ul class="toc_section">
  234. <li> <a href="#History-start">start</a></li>
  235. </ul>
  236. <a class="toc_title" href="#Sync">
  237. Sync
  238. </a>
  239. <ul class="toc_section">
  240. <li> <a href="#Sync">Backbone.sync</a></li>
  241. <li> <a href="#Sync-emulateHTTP">Backbone.emulateHTTP</a></li>
  242. <li> <a href="#Sync-emulateJSON">Backbone.emulateJSON</a></li>
  243. </ul>
  244. <a class="toc_title" href="#View">
  245. View
  246. </a>
  247. <ul class="toc_section">
  248. <li> <a href="#View-extend">extend</a></li>
  249. <li> <a href="#View-constructor">constructor / initialize</a></li>
  250. <li> <a href="#View-el">el</a></li>
  251. <li> <a href="#View-dollar">$ (jQuery or Zepto)</a></li>
  252. <li> <a href="#View-render">render</a></li>
  253. <li> <a href="#View-remove">remove</a></li>
  254. <li> <a href="#View-make">make</a></li>
  255. <li> <a href="#View-delegateEvents">delegateEvents</a></li>
  256. </ul>
  257. <a class="toc_title" href="#Utility">
  258. Utility
  259. </a>
  260. <ul class="toc_section">
  261. <li> <a href="#Utility-noConflict">noConflict</a></li>
  262. </ul>
  263. <a class="toc_title" href="#examples">
  264. Examples
  265. </a>
  266. <ul class="toc_section">
  267. <li> <a href="#examples-todos">Todos</a></li>
  268. <li> <a href="#examples-documentcloud">DocumentCloud</a></li>
  269. <li> <a href="#examples-linkedin">LinkedIn Mobile</a></li>
  270. <li> <a href="#examples-flow">Flow</a></li>
  271. <li> <a href="#examples-audiovroom">AudioVroom</a></li>
  272. <li> <a href="#examples-foursquare">Foursquare</a></li>
  273. <li> <a href="#examples-do">Do</a></li>
  274. <li> <a href="#examples-posterous">Posterous Spaces</a></li>
  275. <li> <a href="#examples-groupon">Groupon Now!</a></li>
  276. <li> <a href="#examples-basecamp">Basecamp Mobile</a></li>
  277. <li> <a href="#examples-slavery-footprint">Slavery Footprint</a></li>
  278. <li> <a href="#examples-trajectory">Trajectory</a></li>
  279. <li> <a href="#examples-soundcloud">SoundCloud Mobile</a></li>
  280. <li> <a href="#examples-pandora">Pandora</a></li>
  281. <li> <a href="#examples-cloudapp">CloudApp</a></li>
  282. <li> <a href="#examples-seatgeek">SeatGeek</a></li>
  283. <li> <a href="#examples-tpm">Talking Points Memo</a></li>
  284. <li> <a href="#examples-grove">Grove.io</a></li>
  285. <li> <a href="#examples-kicksend">Kicksend</a></li>
  286. <li> <a href="#examples-shortmail">Shortmail</a></li>
  287. <li> <a href="#examples-battlefield">Battlefield Play4Free</a></li>
  288. <li> <a href="#examples-salon">Salon.io</a></li>
  289. <li> <a href="#examples-quoteroller">Quote Roller</a></li>
  290. <li> <a href="#examples-tilemill">TileMill</a></li>
  291. <li> <a href="#examples-rround">rround.me</a></li>
  292. <li>- <a href="#examples-blossom">Blossom</a></li>
  293. <li>- <a href="#examples-instagreat">Insta-great!</a></li>
  294. <li>- <a href="#examples-decide">Decide</a></li>
  295. <li>- <a href="#examples-trello">Trello</a></li>
  296. <li>- <a href="#examples-bittorrent">BitTorrent</a></li>
  297. <li>- <a href="#examples-chop">Chop</a></li>
  298. <li>- <a href="#examples-ducksboard">Ducksboard</a></li>
  299. <li>- <a href="#examples-quietwrite">QuietWrite</a></li>
  300. <li>- <a href="#examples-tzigla">Tzigla</a></li>
  301. </ul>
  302. <a class="toc_title" href="#faq">
  303. F.A.Q.
  304. </a>
  305. <ul class="toc_section">
  306. <li> <a href="#FAQ-events">Catalog of Events</a></li>
  307. <li> <a href="#FAQ-tim-toady">More Than One Way To Do It</a></li>
  308. <li> <a href="#FAQ-nested">Nested Models &amp; Collections</a></li>
  309. <li> <a href="#FAQ-bootstrap">Loading Bootstrapped Models</a></li>
  310. <li> <a href="#FAQ-mvc">Traditional MVC</a></li>
  311. <li> <a href="#FAQ-this">Binding "this"</a></li>
  312. </ul>
  313. <a class="toc_title" href="#changelog">
  314. Change Log
  315. </a>
  316. </div>
  317. <div class="container">
  318. <p>
  319. <img style="width: 451px; height: 80px;" src="docs/images/backbone.png" alt="Backbone.js" />
  320. </p>
  321. <p>
  322. <a href="http://github.com/documentcloud/backbone/">Backbone</a>
  323. supplies structure to JavaScript-heavy applications by providing <b>models</b> with
  324. key-value binding and custom events, <b>collections</b> with a rich API of enumerable functions,
  325. <b>views</b> with declarative event handling, and connects it all to your
  326. existing application over a RESTful JSON interface.
  327. </p>
  328. <p>
  329. The project is <a href="http://github.com/documentcloud/backbone/">hosted on GitHub</a>,
  330. and the <a href="docs/backbone.html">annotated source code</a> is available,
  331. as well as an online <a href="test/test.html">test suite</a>, an
  332. <a href="examples/todos/index.html">example application</a> and a
  333. <a href="https://github.com/documentcloud/backbone/wiki/Tutorials%2C-blog-posts-and-example-sites">list of tutorials</a>.
  334. </p>
  335. <p>
  336. You can report bugs and discuss features on the
  337. <a href="http://github.com/documentcloud/backbone/issues">GitHub issues page</a>,
  338. on Freenode IRC in the <tt>#documentcloud</tt> channel, post questions to the
  339. <a href="https://groups.google.com/forum/#!forum/backbonejs">Google Group</a>,
  340. or send tweets to <a href="http://twitter.com/documentcloud">@documentcloud</a>.
  341. </p>
  342. <p>
  343. <i>
  344. Backbone is an open-source component of
  345. <a href="http://documentcloud.org/">DocumentCloud</a>.
  346. </i>
  347. </p>
  348. <h2 id="downloads">
  349. Downloads &amp; Dependencies
  350. <span style="padding-left: 7px; font-size:11px; font-weight: normal;" class="interface">(Right-click, and use "Save As")</span>
  351. </h2>
  352. <table>
  353. <tr>
  354. <td><a href="backbone.js">Development Version (0.5.3)</a></td>
  355. <td><i>41kb, Full Source with Comments</i></td>
  356. </tr>
  357. <tr>
  358. <td><a href="backbone-min.js">Production Version (0.5.3)</a></td>
  359. <td><i>4.6kb, Packed and Gzipped</i></td>
  360. </tr>
  361. </table>
  362. <p>
  363. Backbone's only hard dependency is
  364. <a href="http://documentcloud.github.com/underscore/">Underscore.js</a>.
  365. For RESTful persistence, history support via <a href="#Router">Backbone.Router</a>
  366. and DOM manipulation with <a href="#View">Backbone.View</a>, include
  367. <a href="https://github.com/douglascrockford/JSON-js">json2.js</a>, and either
  368. <a href="http://jquery.com">jQuery</a> <small>( > 1.4.2)</small> or
  369. <a href="http://zeptojs.com/">Zepto</a>.
  370. </p>
  371. <h2 id="Introduction">Introduction</h2>
  372. <p>
  373. When working on a web application that involves a lot of JavaScript, one
  374. of the first things you learn is to stop tying your data to the DOM. It's all
  375. too easy to create JavaScript applications that end up as tangled piles of
  376. jQuery selectors and callbacks, all trying frantically to keep data in
  377. sync between the HTML UI, your JavaScript logic, and the database on your
  378. server. For rich client-side applications, a more structured approach
  379. is often helpful.
  380. </p>
  381. <p>
  382. With Backbone, you represent your data as
  383. <a href="#Model">Models</a>, which can be created, validated, destroyed,
  384. and saved to the server. Whenever a UI action causes an attribute of
  385. a model to change, the model triggers a <i>"change"</i> event; all
  386. the <a href="#View">Views</a> that display the model's data are notified of the
  387. event, causing them to re-render. You don't have to write the glue
  388. code that looks into the DOM to find an element with a specific <i>id</i>,
  389. and update the HTML manually
  390. &mdash; when the model changes, the views simply update themselves.
  391. </p>
  392. <p>
  393. Many of the examples that follow are runnable. Click the <i>play</i> button
  394. to execute them.
  395. </p>
  396. <h2 id="Events">Backbone.Events</h2>
  397. <p>
  398. <b>Events</b> is a module that can be mixed in to any object, giving the
  399. object the ability to bind and trigger custom named events. Events do not
  400. have to be declared before they are bound, and may take passed arguments.
  401. For example:
  402. </p>
  403. <pre class="runnable">
  404. var object = {};
  405. _.extend(object, Backbone.Events);
  406. object.bind("alert", function(msg) {
  407. alert("Triggered " + msg);
  408. });
  409. object.trigger("alert", "an event");
  410. </pre>
  411. <p id="Events-bind">
  412. <b class="header">bind</b><code>object.bind(event, callback, [context])</code>
  413. <br />
  414. Bind a <b>callback</b> function to an object. The callback will be invoked
  415. whenever the <b>event</b> (specified by an arbitrary string identifier) is fired.
  416. If you have a large number of different events on a page, the convention is to use colons to
  417. namespace them: <tt>"poll:start"</tt>, or <tt>"change:selection"</tt>
  418. </p>
  419. <p>
  420. To supply a <b>context</b> value for <tt>this</tt> when the callback is invoked,
  421. pass the optional third argument: <tt>model.bind('change', this.render, this)</tt>
  422. </p>
  423. <p>
  424. Callbacks bound to the special
  425. <tt>"all"</tt> event will be triggered when any event occurs, and are passed
  426. the name of the event as the first argument. For example, to proxy all events
  427. from one object to another:
  428. </p>
  429. <pre>
  430. proxy.bind("all", function(eventName) {
  431. object.trigger(eventName);
  432. });
  433. </pre>
  434. <p id="Events-unbind">
  435. <b class="header">unbind</b><code>object.unbind([event], [callback])</code>
  436. <br />
  437. Remove a previously-bound <b>callback</b> function from an object. If no
  438. callback is specified, all callbacks for the <b>event</b> will be
  439. removed. If no event is specified, <i>all</i> event callbacks on the object
  440. will be removed.
  441. </p>
  442. <pre>
  443. object.unbind("change", onChange); // Removes just the onChange callback.
  444. object.unbind("change"); // Removes all "change" callbacks.
  445. object.unbind(); // Removes all callbacks on object.
  446. </pre>
  447. <p id="Events-trigger">
  448. <b class="header">trigger</b><code>object.trigger(event, [*args])</code>
  449. <br />
  450. Trigger callbacks for the given <b>event</b>. Subsequent arguments to
  451. <b>trigger</b> will be passed along to the event callbacks.
  452. </p>
  453. <h2 id="Model">Backbone.Model</h2>
  454. <p>
  455. <b>Models</b> are the heart of any JavaScript application, containing
  456. the interactive data as well as a large part of the logic surrounding it:
  457. conversions, validations, computed properties, and access control. You
  458. extend <b>Backbone.Model</b> with your domain-specific methods, and
  459. <b>Model</b> provides a basic set of functionality for managing changes.
  460. </p>
  461. <p>
  462. The following is a contrived example, but it demonstrates defining a model
  463. with a custom method, setting an attribute, and firing an event keyed
  464. to changes in that specific attribute.
  465. After running this code once, <tt>sidebar</tt> will be
  466. available in your browser's console, so you can play around with it.
  467. </p>
  468. <pre class="runnable">
  469. var Sidebar = Backbone.Model.extend({
  470. promptColor: function() {
  471. var cssColor = prompt("Please enter a CSS color:");
  472. this.set({color: cssColor});
  473. }
  474. });
  475. window.sidebar = new Sidebar;
  476. sidebar.bind('change:color', function(model, color) {
  477. $('#sidebar').css({background: color});
  478. });
  479. sidebar.set({color: 'white'});
  480. sidebar.promptColor();
  481. </pre>
  482. <p id="Model-extend">
  483. <b class="header">extend</b><code>Backbone.Model.extend(properties, [classProperties])</code>
  484. <br />
  485. To create a <b>Model</b> class of your own, you extend <b>Backbone.Model</b>
  486. and provide instance <b>properties</b>, as well as optional
  487. <b>classProperties</b> to be attached directly to the constructor function.
  488. </p>
  489. <p>
  490. <b>extend</b> correctly sets up the prototype chain, so subclasses created
  491. with <b>extend</b> can be further extended and subclassed as far as you like.
  492. </p>
  493. <pre>
  494. var Note = Backbone.Model.extend({
  495. initialize: function() { ... },
  496. author: function() { ... },
  497. coordinates: function() { ... },
  498. allowedToEdit: function(account) {
  499. return true;
  500. }
  501. });
  502. var PrivateNote = Note.extend({
  503. allowedToEdit: function(account) {
  504. return account.owns(this);
  505. }
  506. });
  507. </pre>
  508. <p class="warning">
  509. Brief aside on <tt>super</tt>: JavaScript does not provide
  510. a simple way to call super &mdash; the function of the same name defined
  511. higher on the prototype chain. If you override a core function like
  512. <tt>set</tt>, or <tt>save</tt>, and you want to invoke the
  513. parent object's implementation, you'll have to explicitly call it, along these lines:
  514. </p>
  515. <pre>
  516. var Note = Backbone.Model.extend({
  517. set: function(attributes, options) {
  518. Backbone.Model.prototype.set.call(this, attributes, options);
  519. ...
  520. }
  521. });
  522. </pre>
  523. <p id="Model-constructor">
  524. <b class="header">constructor / initialize</b><code>new Model([attributes])</code>
  525. <br />
  526. When creating an instance of a model, you can pass in the initial values
  527. of the <b>attributes</b>, which will be <a href="#Model-set">set</a> on the
  528. model. If you define an <b>initialize</b> function, it will be invoked when
  529. the model is created.
  530. </p>
  531. <pre>
  532. new Book({
  533. title: "One Thousand and One Nights",
  534. author: "Scheherazade"
  535. });
  536. </pre>
  537. <p id="Model-get">
  538. <b class="header">get</b><code>model.get(attribute)</code>
  539. <br />
  540. Get the current value of an attribute from the model. For example:
  541. <tt>note.get("title")</tt>
  542. </p>
  543. <p id="Model-set">
  544. <b class="header">set</b><code>model.set(attributes, [options])</code>
  545. <br />
  546. Set a hash of attributes (one or many) on the model. If any of the attributes
  547. change the models state, a <tt>"change"</tt> event will be triggered, unless
  548. <tt>{silent: true}</tt> is passed as an option. Change events for specific
  549. attributes are also triggered, and you can bind to those as well, for example:
  550. <tt>change:title</tt>, and <tt>change:content</tt>.
  551. </p>
  552. <pre>
  553. note.set({title: "October 12", content: "Lorem Ipsum Dolor Sit Amet..."});
  554. </pre>
  555. <p>
  556. If the model has a <a href="#Model-validate">validate</a> method,
  557. it will be validated before the attributes are set, no changes will
  558. occur if the validation fails, and <b>set</b> will return <tt>false</tt>.
  559. You may also pass an <tt>error</tt>
  560. callback in the options, which will be invoked instead of triggering an
  561. <tt>"error"</tt> event, should validation fail.
  562. </p>
  563. <p id="Model-escape">
  564. <b class="header">escape</b><code>model.escape(attribute)</code>
  565. <br />
  566. Similar to <a href="#Model-get">get</a>, but returns the HTML-escaped version
  567. of a model's attribute. If you're interpolating data from the model into
  568. HTML, using <b>escape</b> to retrieve attributes will prevent
  569. <a href="http://en.wikipedia.org/wiki/Cross-site_scripting">XSS</a> attacks.
  570. </p>
  571. <pre class="runnable">
  572. var hacker = new Backbone.Model({
  573. name: "&lt;script&gt;alert('xss')&lt;/script&gt;"
  574. });
  575. alert(hacker.escape('name'));
  576. </pre>
  577. <p id="Model-has">
  578. <b class="header">has</b><code>model.has(attribute)</code>
  579. <br />
  580. Returns <tt>true</tt> if the attribute is set to a non-null or non-undefined
  581. value.
  582. </p>
  583. <pre>
  584. if (note.has("title")) {
  585. ...
  586. }
  587. </pre>
  588. <p id="Model-unset">
  589. <b class="header">unset</b><code>model.unset(attribute, [options])</code>
  590. <br />
  591. Remove an attribute by deleting it from the internal attributes hash.
  592. Fires a <tt>"change"</tt> event unless <tt>silent</tt> is passed as an option.
  593. </p>
  594. <p id="Model-clear">
  595. <b class="header">clear</b><code>model.clear([options])</code>
  596. <br />
  597. Removes all attributes from the model. Fires a <tt>"change"</tt> event unless
  598. <tt>silent</tt> is passed as an option.
  599. </p>
  600. <p id="Model-id">
  601. <b class="header">id</b><code>model.id</code>
  602. <br />
  603. A special property of models, the <b>id</b> is an arbitrary string
  604. (integer id or UUID). If you set the <b>id</b> in the
  605. attributes hash, it will be copied onto the model as a direct property.
  606. Models can be retrieved by id from collections, and the id is used to generate
  607. model URLs by default.
  608. </p>
  609. <p id="Model-cid">
  610. <b class="header">cid</b><code>model.cid</code>
  611. <br />
  612. A special property of models, the <b>cid</b> or client id is a unique identifier
  613. automatically assigned to all models when they're first created. Client ids
  614. are handy when the model has not yet been saved to the server, and does not
  615. yet have its eventual true <b>id</b>, but already needs to be visible in the UI.
  616. Client ids take the form: <tt>c1, c2, c3 ...</tt>
  617. </p>
  618. <p id="Model-attributes">
  619. <b class="header">attributes</b><code>model.attributes</code>
  620. <br />
  621. The <b>attributes</b> property is the internal hash containing the model's
  622. state. Please use <a href="#Model-set">set</a> to update the attributes instead of modifying
  623. them directly. If you'd like to retrieve and munge a copy of the model's
  624. attributes, use <a href="#Model-toJSON">toJSON</a> instead.
  625. </p>
  626. <p id="Model-defaults">
  627. <b class="header">defaults</b><code>model.defaults or model.defaults()</code>
  628. <br />
  629. The <b>defaults</b> hash (or function) can be used to specify the default
  630. attributes for your model. When creating an instance of the model,
  631. any unspecified attributes will be set to their default value.
  632. </p>
  633. <pre class="runnable">
  634. var Meal = Backbone.Model.extend({
  635. defaults: {
  636. "appetizer": "caesar salad",
  637. "entree": "ravioli",
  638. "dessert": "cheesecake"
  639. }
  640. });
  641. alert("Dessert will be " + (new Meal).get('dessert'));
  642. </pre>
  643. <p class="warning">
  644. Remember that in JavaScript, objects are passed by reference, so if you
  645. include an object as a default value, it will be shared among all instances.
  646. </p>
  647. <p id="Model-toJSON">
  648. <b class="header">toJSON</b><code>model.toJSON()</code>
  649. <br />
  650. Return a copy of the model's <a href="#Model-attributes">attributes</a> for JSON stringification.
  651. This can be used for persistence, serialization, or for augmentation before
  652. being handed off to a view. The name of this method is a bit confusing, as
  653. it doesn't actually return a JSON string &mdash; but I'm afraid that it's
  654. the way that the <a href="https://developer.mozilla.org/en/JSON#toJSON()_method">JavaScript API for <b>JSON.stringify</b> works</a>.
  655. </p>
  656. <pre class="runnable">
  657. var artist = new Backbone.Model({
  658. firstName: "Wassily",
  659. lastName: "Kandinsky"
  660. });
  661. artist.set({birthday: "December 16, 1866"});
  662. alert(JSON.stringify(artist));
  663. </pre>
  664. <p id="Model-fetch">
  665. <b class="header">fetch</b><code>model.fetch([options])</code>
  666. <br />
  667. Resets the model's state from the server. Useful if the model has never
  668. been populated with data, or if you'd like to ensure that you have the
  669. latest server state. A <tt>"change"</tt> event will be triggered if the
  670. server's state differs from the current attributes. Accepts
  671. <tt>success</tt> and <tt>error</tt> callbacks in the options hash, which
  672. are passed <tt>(model, response)</tt> as arguments.
  673. </p>
  674. <pre>
  675. // Poll every 10 seconds to keep the channel model up-to-date.
  676. setInterval(function() {
  677. channel.fetch();
  678. }, 10000);
  679. </pre>
  680. <p id="Model-save">
  681. <b class="header">save</b><code>model.save([attributes], [options])</code>
  682. <br />
  683. Save a model to your database (or alternative persistence layer),
  684. by delegating to <a href="#Sync">Backbone.sync</a>. The <b>attributes</b>
  685. hash (as in <a href="#Model-set">set</a>) should contain the attributes
  686. you'd like to change -- keys that aren't mentioned won't be altered.
  687. If the model has a <a href="#Model-validate">validate</a>
  688. method, and validation fails, the model will not be saved. If the model
  689. <a href="#Model-isNew">isNew</a>, the save will be a <tt>"create"</tt>
  690. (HTTP <tt>POST</tt>), if the model already
  691. exists on the server, the save will be an <tt>"update"</tt> (HTTP <tt>PUT</tt>).
  692. </p>
  693. <p>
  694. In the following example, notice how our overridden version
  695. of <tt>Backbone.sync</tt> receives a <tt>"create"</tt> request
  696. the first time the model is saved and an <tt>"update"</tt>
  697. request the second time.
  698. </p>
  699. <pre class="runnable">
  700. Backbone.sync = function(method, model) {
  701. alert(method + ": " + JSON.stringify(model));
  702. model.id = 1;
  703. };
  704. var book = new Backbone.Model({
  705. title: "The Rough Riders",
  706. author: "Theodore Roosevelt"
  707. });
  708. book.save();
  709. book.save({author: "Teddy"});
  710. </pre>
  711. <p>
  712. <b>save</b> accepts <tt>success</tt> and <tt>error</tt> callbacks in the
  713. options hash, which are passed <tt>(model, response)</tt> as arguments.
  714. The <tt>error</tt> callback will also be invoked if the model has a
  715. <tt>validate</tt> method, and validation fails. If a server-side
  716. validation fails, return a non-<tt>200</tt> HTTP response code, along with
  717. an error response in text or JSON.
  718. </p>
  719. <pre>
  720. book.save({author: "F.D.R."}, {error: function(){ ... }});
  721. </pre>
  722. <p id="Model-destroy">
  723. <b class="header">destroy</b><code>model.destroy([options])</code>
  724. <br />
  725. Destroys the model on the server by delegating an HTTP <tt>DELETE</tt>
  726. request to <a href="#Sync">Backbone.sync</a>. Accepts
  727. <tt>success</tt> and <tt>error</tt> callbacks in the options hash.
  728. Triggers a <tt>"destroy"</tt> event on the model, which will bubble up
  729. through any collections that contain it.
  730. </p>
  731. <pre>
  732. book.destroy({success: function(model, response) {
  733. ...
  734. }});
  735. </pre>
  736. <p id="Model-validate">
  737. <b class="header">validate</b><code>model.validate(attributes)</code>
  738. <br />
  739. This method is left undefined, and you're encouraged to override it with
  740. your custom validation logic, if you have any that can be performed
  741. in JavaScript. <b>validate</b> is called before <tt>set</tt> and
  742. <tt>save</tt>, and is passed the attributes that are about to be updated.
  743. If the model and attributes are valid, don't return anything from <b>validate</b>;
  744. if the attributes are invalid, return an error of your choosing. It
  745. can be as simple as a string error message to be displayed, or a complete
  746. error object that describes the error programmatically. <tt>set</tt> and
  747. <tt>save</tt> will not continue if <b>validate</b> returns an error.
  748. Failed validations trigger an <tt>"error"</tt> event.
  749. </p>
  750. <pre class="runnable">
  751. var Chapter = Backbone.Model.extend({
  752. validate: function(attrs) {
  753. if (attrs.end < attrs.start) {
  754. return "can't end before it starts";
  755. }
  756. }
  757. });
  758. var one = new Chapter({
  759. title : "Chapter One: The Beginning"
  760. });
  761. one.bind("error", function(model, error) {
  762. alert(model.get("title") + " " + error);
  763. });
  764. one.set({
  765. start: 15,
  766. end: 10
  767. });
  768. </pre>
  769. <p>
  770. <tt>"error"</tt> events are useful for providing coarse-grained error
  771. messages at the model or collection level, but if you have a specific view
  772. that can better handle the error, you may override and suppress the event
  773. by passing an <tt>error</tt> callback directly:
  774. </p>
  775. <pre>
  776. account.set({access: "unlimited"}, {
  777. error: function(model, error) {
  778. alert(error);
  779. }
  780. });
  781. </pre>
  782. <p id="Model-url">
  783. <b class="header">url</b><code>model.url()</code>
  784. <br />
  785. Returns the relative URL where the model's resource would be located on
  786. the server. If your models are located somewhere else, override this method
  787. with the correct logic. Generates URLs of the form: <tt>"/[collection.url]/[id]"</tt>,
  788. falling back to <tt>"/[urlRoot]/id"</tt> if the model is not part of a collection.
  789. </p>
  790. <p>
  791. Delegates to <a href="#Collection-url">Collection#url</a> to generate the
  792. URL, so make sure that you have it defined, or a <a href="#Model-urlRoot">urlRoot</a>
  793. property, if all models of this class share a common root URL.
  794. A model with an id of <tt>101</tt>, stored in a
  795. <a href="#Collection">Backbone.Collection</a> with a <tt>url</tt> of <tt>"/documents/7/notes"</tt>,
  796. would have this URL: <tt>"/documents/7/notes/101"</tt>
  797. </p>
  798. <p id="Model-urlRoot">
  799. <b class="header">urlRoot</b><code>model.urlRoot</code>
  800. <br />
  801. Specify a <tt>urlRoot</tt> if you're using a model outside of a collection,
  802. to enable the default <a href="#Model-url">url</a> function to generate
  803. URLs based on the model id. <tt>"/[urlRoot]/id"</tt>
  804. </p>
  805. <pre class="runnable">
  806. var Book = Backbone.Model.extend({urlRoot : '/books'});
  807. var solaris = new Book({id: "1083-lem-solaris"});
  808. alert(solaris.url());
  809. </pre>
  810. <p id="Model-parse">
  811. <b class="header">parse</b><code>model.parse(response)</code>
  812. <br />
  813. <b>parse</b> is called whenever a model's data is returned by the
  814. server, in <a href="#Model-fetch">fetch</a>, and <a href="#Model-save">save</a>.
  815. The function is passed the raw <tt>response</tt> object, and should return
  816. the attributes hash to be <a href="#Model-set">set</a> on the model. The
  817. default implementation is a no-op, simply passing through the JSON response.
  818. Override this if you need to work with a preexisting API, or better namespace
  819. your responses.
  820. </p>
  821. <p>
  822. If you're working with a Rails backend, you'll notice that Rails' default
  823. <tt>to_json</tt> implementation includes a model's attributes under a
  824. namespace. To disable this behavior for seamless Backbone integration, set:
  825. </p>
  826. <pre>
  827. ActiveRecord::Base.include_root_in_json = false
  828. </pre>
  829. <p id="Model-clone">
  830. <b class="header">clone</b><code>model.clone()</code>
  831. <br />
  832. Returns a new instance of the model with identical attributes.
  833. </p>
  834. <p id="Model-isNew">
  835. <b class="header">isNew</b><code>model.isNew()</code>
  836. <br />
  837. Has this model been saved to the server yet? If the model does not yet have
  838. an <tt>id</tt>, it is considered to be new.
  839. </p>
  840. <p id="Model-change">
  841. <b class="header">change</b><code>model.change()</code>
  842. <br />
  843. Manually trigger the <tt>"change"</tt> event.
  844. If you've been passing <tt>{silent: true}</tt> to the <a href="#Model-set">set</a> function in order to
  845. aggregate rapid changes to a model, you'll want to call <tt>model.change()</tt>
  846. when you're all finished.
  847. </p>
  848. <p id="Model-hasChanged">
  849. <b class="header">hasChanged</b><code>model.hasChanged([attribute])</code>
  850. <br />
  851. Has the model changed since the last <tt>"change"</tt> event? If an <b>attribute</b>
  852. is passed, returns <tt>true</tt> if that specific attribute has changed.
  853. </p>
  854. <p class="warning">
  855. Note that this method, and the following change-related ones,
  856. are only useful during the course of a <tt>"change"</tt> event.
  857. </p>
  858. <pre>
  859. book.bind("change", function() {
  860. if (book.hasChanged("title")) {
  861. ...
  862. }
  863. });
  864. </pre>
  865. <p id="Model-changedAttributes">
  866. <b class="header">changedAttributes</b><code>model.changedAttributes([attributes])</code>
  867. <br />
  868. Retrieve a hash of only the model's attributes that have changed. Optionally,
  869. an external <b>attributes</b> hash can be passed in, returning
  870. the attributes in that hash which differ from the model. This can be used
  871. to figure out which portions of a view should be updated, or what calls
  872. need to be made to sync the changes to the server.
  873. </p>
  874. <p id="Model-previous">
  875. <b class="header">previous</b><code>model.previous(attribute)</code>
  876. <br />
  877. During a <tt>"change"</tt> event, this method can be used to get the
  878. previous value of a changed attribute.
  879. </p>
  880. <pre class="runnable">
  881. var bill = new Backbone.Model({
  882. name: "Bill Smith"
  883. });
  884. bill.bind("change:name", function(model, name) {
  885. alert("Changed name from " + bill.previous("name") + " to " + name);
  886. });
  887. bill.set({name : "Bill Jones"});
  888. </pre>
  889. <p id="Model-previousAttributes">
  890. <b class="header">previousAttributes</b><code>model.previousAttributes()</code>
  891. <br />
  892. Return a copy of the model's previous attributes. Useful for getting a
  893. diff between versions of a model, or getting back to a valid state after
  894. an error occurs.
  895. </p>
  896. <h2 id="Collection">Backbone.Collection</h2>
  897. <p>
  898. Collections are ordered sets of models. You can bind <tt>"change"</tt> events
  899. to be notified when any model in the collection has been modified,
  900. listen for <tt>"add"</tt> and <tt>"remove"</tt> events, <tt>fetch</tt>
  901. the collection from the server, and use a full suite of
  902. <a href="#Collection-Underscore-Methods">Underscore.js methods</a>.
  903. </p>
  904. <p>
  905. Any event that is triggered on a model in a collection will also be
  906. triggered on the collection directly, for convenience.
  907. This allows you to listen for changes to specific attributes in any
  908. model in a collection, for example:
  909. <tt>Documents.bind("change:selected", ...)</tt>
  910. </p>
  911. <p id="Collection-extend">
  912. <b class="header">extend</b><code>Backbone.Collection.extend(properties, [classProperties])</code>
  913. <br />
  914. To create a <b>Collection</b> class of your own, extend <b>Backbone.Collection</b>,
  915. providing instance <b>properties</b>, as well as optional <b>classProperties</b> to be attached
  916. directly to the collection's constructor function.
  917. </p>
  918. <p id="Collection-model">
  919. <b class="header">model</b><code>collection.model</code>
  920. <br />
  921. Override this property to specify the model class that the collection
  922. contains. If defined, you can pass raw attributes objects (and arrays) to
  923. <a href="#Collection-add">add</a>, <a href="#Collection-create">create</a>,
  924. and <a href="#Collection-reset">reset</a>, and the attributes will be
  925. converted into a model of the proper type.
  926. </p>
  927. <pre>
  928. var Library = Backbone.Collection.extend({
  929. model: Book
  930. });
  931. </pre>
  932. <p id="Collection-constructor">
  933. <b class="header">constructor / initialize</b><code>new Collection([models], [options])</code>
  934. <br />
  935. When creating a Collection, you may choose to pass in the initial array of <b>models</b>.
  936. The collection's <a href="#Collection-comparator">comparator</a> function
  937. may be included as an option. If you define an <b>initialize</b> function, it will be
  938. invoked when the collection is created.
  939. </p>
  940. <pre>
  941. var tabs = new TabSet([tab1, tab2, tab3]);
  942. </pre>
  943. <p id="Collection-models">
  944. <b class="header">models</b><code>collection.models</code>
  945. <br />
  946. Raw access to the JavaScript array of models inside of the collection. Usually you'll
  947. want to use <tt>get</tt>, <tt>at</tt>, or the <b>Underscore methods</b>
  948. to access model objects, but occasionally a direct reference to the array
  949. is desired.
  950. </p>
  951. <p id="Collection-toJSON">
  952. <b class="header">toJSON</b><code>collection.toJSON()</code>
  953. <br />
  954. Return an array containing the attributes hash of each model in the
  955. collection. This can be used to serialize and persist the
  956. collection as a whole. The name of this method is a bit confusing, because
  957. it conforms to
  958. <a href="https://developer.mozilla.org/en/JSON#toJSON()_method">JavaScript's JSON API</a>.
  959. </p>
  960. <pre class="runnable">
  961. var collection = new Backbone.Collection([
  962. {name: "Tim", age: 5},
  963. {name: "Ida", age: 26},
  964. {name: "Rob", age: 55}
  965. ]);
  966. alert(JSON.stringify(collection));
  967. </pre>
  968. <p id="Collection-Underscore-Methods">
  969. <b class="header">Underscore Methods (26)</b>
  970. <br />
  971. Backbone proxies to <b>Underscore.js</b> to provide 26 iteration functions
  972. on <b>Backbone.Collection</b>. They aren't all documented here, but
  973. you can take a look at the Underscore documentation for the full details&hellip;
  974. </p>
  975. <ul>
  976. <li><a href="http://documentcloud.github.com/underscore/#each">forEach (each)</a></li>
  977. <li><a href="http://documentcloud.github.com/underscore/#map">map</a></li>
  978. <li><a href="http://documentcloud.github.com/underscore/#reduce">reduce (foldl, inject)</a></li>
  979. <li><a href="http://documentcloud.github.com/underscore/#reduceRight">reduceRight (foldr)</a></li>
  980. <li><a href="http://documentcloud.github.com/underscore/#detect">find (detect)</a></li>
  981. <li><a href="http://documentcloud.github.com/underscore/#select">filter (select)</a></li>
  982. <li><a href="http://documentcloud.github.com/underscore/#reject">reject</a></li>
  983. <li><a href="http://documentcloud.github.com/underscore/#all">every (all)</a></li>
  984. <li><a href="http://documentcloud.github.com/underscore/#any">some (any)</a></li>
  985. <li><a href="http://documentcloud.github.com/underscore/#include">include</a></li>
  986. <li><a href="http://documentcloud.github.com/underscore/#invoke">invoke</a></li>
  987. <li><a href="http://documentcloud.github.com/underscore/#max">max</a></li>
  988. <li><a href="http://documentcloud.github.com/underscore/#min">min</a></li>
  989. <li><a href="http://documentcloud.github.com/underscore/#sortBy">sortBy</a></li>
  990. <li><a href="http://documentcloud.github.com/underscore/#groupBy">groupBy</a></li>
  991. <li><a href="http://documentcloud.github.com/underscore/#sortedIndex">sortedIndex</a></li>
  992. <li><a href="http://documentcloud.github.com/underscore/#toArray">toArray</a></li>
  993. <li><a href="http://documentcloud.github.com/underscore/#size">size</a></li>
  994. <li><a href="http://documentcloud.github.com/underscore/#first">first</a></li>
  995. <li><a href="http://documentcloud.github.com/underscore/#rest">rest</a></li>
  996. <li><a href="http://documentcloud.github.com/underscore/#last">last</a></li>
  997. <li><a href="http://documentcloud.github.com/underscore/#without">without</a></li>
  998. <li><a href="http://documentcloud.github.com/underscore/#indexOf">indexOf</a></li>
  999. <li><a href="http://documentcloud.github.com/underscore/#lastIndexOf">lastIndexOf</a></li>
  1000. <li><a href="http://documentcloud.github.com/underscore/#isEmpty">isEmpty</a></li>
  1001. <li><a href="http://documentcloud.github.com/underscore/#chain">chain</a></li>
  1002. </ul>
  1003. <pre>
  1004. Books.each(function(book) {
  1005. book.publish();
  1006. });
  1007. var titles = Books.map(function(book) {
  1008. return book.get("title");
  1009. });
  1010. var publishedBooks = Books.filter(function(book) {
  1011. return book.get("published") === true;
  1012. });
  1013. var alphabetical = Books.sortBy(function(book) {
  1014. return book.author.get("name").toLowerCase();
  1015. });
  1016. </pre>
  1017. <p id="Collection-add">
  1018. <b class="header">add</b><code>collection.add(models, [options])</code>
  1019. <br />
  1020. Add a model (or an array of models) to the collection. Fires an <tt>"add"</tt>
  1021. event, which you can pass <tt>{silent: true}</tt> to suppress. If a
  1022. <a href="#Collection-model">model</a> property is defined, you may also pass
  1023. raw attributes objects, and have them be vivified as instances of the model.
  1024. Pass <tt>{at: index}</tt> to splice the model into the collection at the
  1025. specified <tt>index</tt>.
  1026. </p>
  1027. <pre class="runnable">
  1028. var ships = new Backbone.Collection;
  1029. ships.bind("add", function(ship) {
  1030. alert("Ahoy " + ship.get("name") + "!");
  1031. });
  1032. ships.add([
  1033. {name: "Flying Dutchman"},
  1034. {name: "Black Pearl"}
  1035. ]);
  1036. </pre>
  1037. <p id="Collection-remove">
  1038. <b class="header">remove</b><code>collection.remove(models, [options])</code>
  1039. <br />
  1040. Remove a model (or an array of models) from the collection. Fires a
  1041. <tt>"remove"</tt> event, which you can use <tt>silent</tt>
  1042. to suppress.
  1043. </p>
  1044. <p id="Collection-get">
  1045. <b class="header">get</b><code>collection.get(id)</code>
  1046. <br />
  1047. Get a model from a collection, specified by <b>id</b>.
  1048. </p>
  1049. <pre>
  1050. var book = Library.get(110);
  1051. </pre>
  1052. <p id="Collection-getByCid">
  1053. <b class="header">getByCid</b><code>collection.getByCid(cid)</code>
  1054. <br />
  1055. Get a model from a collection, specified by client id. The client id
  1056. is the <tt>.cid</tt> property of the model, automatically assigned whenever
  1057. a model is created. Useful for models which have not yet been saved to
  1058. the server, and do not yet have true ids.
  1059. </p>
  1060. <p id="Collection-at">
  1061. <b class="header">at</b><code>collection.at(index)</code>
  1062. <br />
  1063. Get a model from a collection, specified by index. Useful if your collection
  1064. is sorted, and if your collection isn't sorted, <b>at</b> will still
  1065. retrieve models in insertion order.
  1066. </p>
  1067. <p id="Collection-length">
  1068. <b class="header">length</b><code>collection.length</code>
  1069. <br />
  1070. Like an array, a Collection maintains a <tt>length</tt> property, counting
  1071. the number of models it contains.
  1072. </p>
  1073. <p id="Collection-comparator">
  1074. <b class="header">comparator</b><code>collection.comparator</code>
  1075. <br />
  1076. By default there is no <b>comparator</b> function on a collection.
  1077. If you define a comparator, it will be used to maintain
  1078. the collection in sorted order. This means that as models are added,
  1079. they are inserted at the correct index in <tt>collection.models</tt>.
  1080. Comparator functions take a model and return a numeric or string value
  1081. by which the model should be ordered relative to others.
  1082. </p>
  1083. <p>
  1084. Note how even though all of the chapters in this example are added backwards,
  1085. they come out in the proper order:
  1086. </p>
  1087. <pre class="runnable">
  1088. var Chapter = Backbone.Model;
  1089. var chapters = new Backbone.Collection;
  1090. chapters.comparator = function(chapter) {
  1091. return chapter.get("page");
  1092. };
  1093. chapters.add(new Chapter({page: 9, title: "The End"}));
  1094. chapters.add(new Chapter({page: 5, title: "The Middle"}));
  1095. chapters.add(new Chapter({page: 1, title: "The Beginning"}));
  1096. alert(chapters.pluck('title'));
  1097. </pre>
  1098. <p class="warning">
  1099. Brief aside: This comparator function is different than JavaScript's regular
  1100. "sort", which must return <tt>0</tt>, <tt>1</tt>, or <tt>-1</tt>,
  1101. and is more similar to a <tt>sortBy</tt> &mdash; a much nicer API.
  1102. </p>
  1103. <p class="warning">
  1104. Collections with comparator functions will not automatically re-sort if you
  1105. later change model attributes, so you may wish to call <tt>sort</tt> after
  1106. changing model attributes that would affect the order.
  1107. </p>
  1108. <p id="Collection-sort">
  1109. <b class="header">sort</b><code>collection.sort([options])</code>
  1110. <br />
  1111. Force a collection to re-sort itself. You don't need to call this under
  1112. normal circumstances, as a collection with a <a href="#Collection-comparator">comparator</a> function
  1113. will maintain itself in proper sort order at all times. Calling <b>sort</b>
  1114. triggers the collection's <tt>"reset"</tt> event, unless silenced by passing
  1115. <tt>{silent: true}</tt>
  1116. </p>
  1117. <p id="Collection-pluck">
  1118. <b class="header">pluck</b><code>collection.pluck(attribute)</code>
  1119. <br />
  1120. Pluck an attribute from each model in the collection. Equivalent to calling
  1121. <tt>map</tt>, and returning a single attribute from the iterator.
  1122. </p>
  1123. <pre class="runnable">
  1124. var stooges = new Backbone.Collection([
  1125. new Backbone.Model({name: "Curly"}),
  1126. new Backbone.Model({name: "Larry"}),
  1127. new Backbone.Model({name: "Moe"})
  1128. ]);
  1129. var names = stooges.pluck("name");
  1130. alert(JSON.stringify(names));
  1131. </pre>
  1132. <p id="Collection-url">
  1133. <b class="header">url</b><code>collection.url or collection.url()</code>
  1134. <br />
  1135. Set the <b>url</b> property (or function) on a collection to reference
  1136. its location on the server. Models within the collection will use <b>url</b>
  1137. to construct URLs of their own.
  1138. </p>
  1139. <pre>
  1140. var Notes = Backbone.Collection.extend({
  1141. url: '/notes'
  1142. });
  1143. // Or, something more sophisticated:
  1144. var Notes = Backbone.Collection.extend({
  1145. url: function() {
  1146. return this.document.url() + '/notes';
  1147. }
  1148. });
  1149. </pre>
  1150. <p id="Collection-parse">
  1151. <b class="header">parse</b><code>collection.parse(response)</code>
  1152. <br />
  1153. <b>parse</b> is called by Backbone whenever a collection's models are
  1154. returned by the server, in <a href="#Collection-fetch">fetch</a>.
  1155. The function is passed the raw <tt>response</tt> object, and should return
  1156. the array of model attributes to be <a href="#Collection-add">added</a>
  1157. to the collection. The default implementation is a no-op, simply passing
  1158. through the JSON response. Override this if you need to work with a
  1159. preexisting API, or better namespace your responses.
  1160. </p>
  1161. <pre>
  1162. var Tweets = Backbone.Collection.extend({
  1163. // The Twitter Search API returns tweets under "results".
  1164. parse: function(response) {
  1165. return response.results;
  1166. }
  1167. });
  1168. </pre>
  1169. <p id="Collection-fetch">
  1170. <b class="header">fetch</b><code>collection.fetch([options])</code>
  1171. <br />
  1172. Fetch the default set of models for this collection from the server,
  1173. resetting the collection when they arrive. The <b>options</b> hash takes
  1174. <tt>success</tt> and <tt>error</tt>
  1175. callbacks which will be passed <tt>(collection, response)</tt> as arguments.
  1176. When the model data returns from the server, the collection will
  1177. <a href="#Collection-reset">reset</a>.
  1178. Delegates to <a href="#Sync">Backbone.sync</a>
  1179. under the covers, for custom persistence strategies.
  1180. The server handler for <b>fetch</b> requests should return a JSON array of
  1181. models.
  1182. </p>
  1183. <pre class="runnable">
  1184. Backbone.sync = function(method, model) {
  1185. alert(method + ": " + model.url);
  1186. };
  1187. var Accounts = new Backbone.Collection;
  1188. Accounts.url = '/accounts';
  1189. Accounts.fetch();
  1190. </pre>
  1191. <p>
  1192. If you'd like to add the incoming models to the current collection, instead
  1193. of replacing the collection's contents, pass <tt>{add: true}</tt> as an
  1194. option to <b>fetch</b>.
  1195. </p>
  1196. <p>
  1197. <b>jQuery.ajax</b> options

Large files files are truncated, but you can click here to view the full file