can

<!DOCTYPE html>  <html lang="en"> <head> <meta charset="utf-8"> <title>CanJS - replace</title> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"> <link rel="stylesheet" type="text/css" href="./static/bundles/bit-docs-site/static.css"> <link rel="shortcut icon" sizes="16x16 24x24 32x32 48x48 64x64" href="/docs/images/canjs_favicon.ico"> <link rel="apple-touch-icon" sizes="57x57" href="../docs/images/canjs_favicon_57x57.png"> <link rel="apple-touch-icon-precomposed" sizes="57x57" href="../docs/images/canjs_favicon_57x57.png"> <link rel="apple-touch-icon" sizes="72x72" href="../docs/images/canjs_favicon_72x72.png"> <link rel="apple-touch-icon" sizes="114x114" href="../docs/images/canjs_favicon_114x114.png"> <link rel="apple-touch-icon" sizes="120x120" href="../docs/images/canjs_favicon_128x128.png"> <link rel="apple-touch-icon" sizes="144x144" href="../docs/images/canjs_favicon_144x144.png"> <link rel="apple-touch-icon" sizes="152x152" href="../docs/images/canjs_favicon_152x152.png"> <meta content="yes" name="apple-mobile-web-app-capable"> <meta name="apple-mobile-web-app-status-bar-style" content="white-translucent"> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-2302003-11', 'auto'); ga('send', 'pageview'); </script> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger"/> <label for="nav-trigger">Menu</label> <div id="everything"> <div id="left" class="column"> <div class="top-left"> <div class="brand"> <div class="logo"> <a href="../index.html" alt="CanJS"></a> <div class="dropdown project-dropdown"> <a href="https://donejs.com/">DoneJS</a> <a href="http://stealjs.com/">StealJS</a> <a href="http://jquerypp.com/">jQuery ++</a> <a href="https://funcunit.com/">FuncUnit</a> <a href="http://documentjs.com/">DocumentJS</a> </div> </div> <div class="version"> <div class="version-number"> 3.0.0 </div> <div class="dropdown version-dropdown"> <a href="https://v2.canjs.com">2.3.27</a> </div> </div> </div> <div class="search-bar"> <p>   </p> </div> </div> <div class="bottom-left"> <div class="social-side-container"> <ul class="social-side"> <li> <a class="header-mobile github" href="https://github.com/canjs/canjs" target="_blank"><img class="social-icon-small" src="../docs/images/github.png">Github</a> </li> <li> <a class="header-mobile twitter" href="https://twitter.com/canjs" target="_blank"><img class="social-icon-small" src="../docs/images/twitter.png">Twitter</a> </li> </ul> <ul class="social-side"> <li> <a class="header-mobile" href="https://gitter.im/canjs/canjs" target="_blank">Chat</a> </li> <li> <a class="header-mobile" href="http://forums.donejs.com/c/canjs" target="_blank">Forum</a> </li> </ul> </div> <ul> <li> <span>prototype</span> <ul> <li class=" "> <a class="function" href="can.List.prototype.concat.html" title="Merge many collections together into a List."> concat </a> </li> <li class=" "> <a class="function" href="can.List.prototype.forEach.html" title="Call a function for each element of a List."> forEach </a> </li> <li class=" "> <a class="function" href="can.List.prototype.indexOf.html" title="Look for an item in a List."> indexOf </a> </li> <li class=" "> <a class="function" href="can.List.prototype.join.html" title="Join a List's elements into a string."> join </a> </li> <li class=" "> <a class="function" href="can.List.prototype.pop.html" title="Remove an element from the end of a List."> pop </a> </li> <li class=" "> <a class="function" href="can.List.prototype.push.html" title="Add elements to the end of a list."> push </a> </li> <li class="current parent expanded"> <a class="function" href="can.List.prototype.replace.html" title="Replace all the elements of a List."> replace </a> </li> <li class=" "> <a class="function" href="can.List.prototype.reverse.html" title="Reverse the order of a List."> reverse </a> </li> <li class=" "> <a class="function" href="can.List.prototype.shift.html" title="Remove en element from the front of a list."> shift </a> </li> <li class=" "> <a class="function" href="can.List.prototype.slice.html" title="Make a copy of a part of a List."> slice </a> </li> <li class=" "> <a class="function" href="can.List.prototype.splice.html" title="Insert and remove elements from a List."> splice </a> </li> <li class=" "> <a class="function" href="can.List.prototype.unshift.html" title="Add elements to the beginning of a List."> unshift </a> </li> </ul> </li> <li> <span>static</span> <ul> <li class=" "> <a class="property" href="can.List.Map.html" title="Specify the Map type used to make objects added to this list observable."> can.List.Map </a> </li> </ul> </li> </ul> </div> </div> <div id="right" class="column"> <div class="top-right"> <div class="top-right-top"> <ul class="top-right-bitovi"> <li class="dropdown"> <a href="http://bitovi.com" class="bitovi icon-bits">Bitovi</a> <ul class="dropdown-menu"> <li><a href="http://bitovi.com">Bitovi.com</a></li> <li><a href="http://bitovi.com/blog/">Blog</a></li> <li><a href="http://bitovi.com/consulting/">Consulting</a></li> <li><a href="http://bitovi.com/training/">Training</a></li> <li><a href="http://bitovi.com/open-source/">Open Source</a></li> </ul> </li> </ul> <div class="brand"> <div class="logo"> <a href="../index.html" alt="CanJS"></a> </div> </div> <ul class="top-right-links"> <li> <a href="https://gitter.im/canjs/canjs">Chat</a> </li> <li> <a href="http://forums.donejs.com/c/canjs">Forum</a> </li> <li> <a class="github-button nav-social" href="https://github.com/canjs/canjs" data-count-href="/canjs/canjs/stargazers" data-count-api="/repos/canjs/canjs#stargazers_count">Star</a> </li> <li> <a href="https://twitter.com/canjs" class="twitter-follow-button nav-social" data-show-count="true" data-show-screen-name="false">Follow @canjs</a><script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script> </li> </ul> </div> <div class="breadcrumb"> <li><a href="can.List.html">can.List</a></li> / <li><a href="can.List.prototype.replace.html">replace</a></li> <li class="breadcrumb-dropdown">/ <a> On this page</a> <ul class="on-this-page"></ul> </li> <div class="nav-toggle" title="Back to top"></div> </div> </div> <div class="bottom-right"> <article> <section class="title"> <div class="page-type"> <h1>replace</h1> <div>function</div> </div> <section class="description"> <p>Replace all the elements of a List.</p> </section> </section> <section class="on-this-page-table"> </section> <section class="title-footer"> <ul class="title-links">  <li><a href="//github.com/canjs/canjs/tree/v3.0.0/node_modules/can-list/can-list.js#L843">source</a></li>   </ul> </section> <div class="signature"> <h2 class="signature-title"> <code>list.replace(collection)</code> </h2> <div class="parameters"> <h3 class="parameters-title">Parameters</h3> <ol> <li><b>collection</b> <code>{Array|<a href="can.List.html" title="undefined">can.List</a>|can.Deferred}</code>: <p>the collection of new elements to use If a [can.Deferred] is passed, it must resolve to an <code>Array</code> or <code>can.List</code>. The elements of the list are not actually removed until the Deferred resolves.</p> </li> </ol> </div> </div> <section class="body"> <p><code>replace</code> replaces all the elements of this List with new ones.</p> <p><code>replace</code> is especially useful when <code>can.List</code>s are live-bound into <code><a href="can.Control.html" title="undefined">can.Control</a></code>s, and you intend to populate them with the results of a <code>[can.Model]</code> call:</p> <pre><code>can.Control({ init: function() { this.list = new Todo.List(); // live-bind the list into the DOM this.element.html(can.view('list.stache', this.list)); // when this AJAX call returns, the live-bound DOM will be updated this.list.replace(Todo.findAll()); } }); </code></pre> <p>Learn more about [can.Model.List making Lists of models].</p> <h2>Events</h2> <p>A major difference between <code>replace</code> and <code>attr(newElements, true)</code> is that <code>replace</code> always emits an <em>add</em> event and a <em>remove</em> event, whereas <code>attr</code> will cause <em>set</em> events along with an <em>add</em> or <em>remove</em> event if needed. Corresponding <em>change</em> and <em>length</em> events will be fired as well.</p> <p>The differences in the events fired by <code>attr</code> and <code>replace</code> are demonstrated concretely by this example:</p> <pre><code>var attrList = new can.List(['Alexis', 'Bill']); attrList.bind('change', function(ev, index, how, newVals, oldVals) { console.log(index + ', ' + how + ', ' + newVals + ', ' + oldVals); }); var replaceList = new can.List(['Alexis', 'Bill']); replaceList.bind('change', function(ev, index, how, newVals, oldVals) { console.log(index + ', ' + how + ', ' + newVals + ', ' + oldVals); }); attrList.attr(['Adam', 'Ben'], true); // 0, set, Adam, Alexis // 1, set, Ben, Bill replaceList.replace(['Adam', 'Ben']); // 0, remove, undefined, ['Alexis', 'Bill'] // 0, add, ['Adam', 'Ben'], ['Alexis', 'Bill'] attrList.attr(['Amber'], true); // 0, set, Amber, Adam // 1, remove, undefined, Ben replaceList.replace(['Amber']); // 0, remove, undefined, ['Adam', 'Ben'] // 0, add, Amber, ['Adam', 'Ben'] attrList.attr(['Alice', 'Bob', 'Eve'], true); // 0, set, Alice, Amber // 1, add, ['Bob', 'Eve'], undefined replaceList.replace(['Alice', 'Bob', 'Eve']); // 0, remove, undefined, Amber // 0, add, ['Alice', 'Bob', 'Eve'], Amber </code></pre> </section> <script type="text/javascript"> var docObject = {"type":"function","name":"can.List.prototype.replace","parent":"can.List.prototype","src":{"line":843,"codeLine":905,"path":"node_modules/can-list/can-list.js"},"description":"Replace all the elements of a List. ","title":"replace","signatures":[{"code":"list.replace(collection)","description":"","params":[{"types":[{"type":"Array"},{"type":"can.List"},{"type":"can.Deferred"}],"name":"collection","description":"the collection of new elements to use\nIf a [can.Deferred] is passed, it must resolve to an `Array` or `can.List`.\nThe elements of the list are not actually removed until the Deferred resolves.\n"}]}],"_curParam":{"types":[{"type":"Array"},{"type":"can.List"},{"type":"can.Deferred"}],"name":"collection","description":"the collection of new elements to use\nIf a [can.Deferred] is passed, it must resolve to an `Array` or `can.List`.\nThe elements of the list are not actually removed until the Deferred resolves.\n"},"comment":" ","pathToRoot":".."}; </script> </article> <footer><p>CanJS is part of <a href="http://donejs.com" target="_blank">DoneJS</a>. Created and maintained by the core <a href="https://donejs.com/About.html#section=section_Team" target="_blank">DoneJS team</a> and <a href="http://bitovi.com" target="_blank">Bitovi</a>. <strong>Currently 3.0.0.</strong></p></footer> </div> </div> </div> <script> steal = { instantiated: { "bundles/bit-docs-site/static.css!$css" : null } }; </script> <script type='text/javascript' data-main="bit-docs-site/static" src="./static/node_modules/steal/steal.production.js"></script> <script async defer src="https://buttons.github.io/buttons.js"></script> </body> </html>