BackboneJS - Collection Reset


Advertisements

Description

It resets the collection and populates with the new array of models or will empty the entire collection.

Syntax

collection.reset(models,options)

Parameters

  • models − It contains the names of the collection instances, which need to be reset in the collection.

  • options − The options include null value to empty the collection.

Example

<!DOCTYPE html>
<html>
   <head>
      <title>Collection Example</title>
      <script src = "https://code.jquery.com/jquery-2.1.3.min.js"
         type = "text/javascript"></script>
      
      <script src = "https://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.8.2/underscore-min.js"
         type = "text/javascript"></script>
      
      <script src = "https://cdnjs.cloudflare.com/ajax/libs/backbone.js/1.1.2/backbone-min.js"
         type = "text/javascript"></script>
   </head>
   
   <body>
      <script type = "text/javascript">
         
         //The 'C_Name' is a model name and includes default value
         var C_Name = Backbone.Model.extend ({
            defaults: {
               country: "sachin"
            }
         });
         
         //'PlayersCollection' is an instance of collection and model 'C_Name' is specified by using 
         //model property
         var PlayersCollection = Backbone.Collection.extend ({
            model: C_Name
         });
         
         //The 'country1' and 'country2' are the instances of the model 'C_name'
         var country1 = new C_Name({country: "australia"});
         var country2 = new C_Name({country: "england"});

         //Add the model instances to the collection using 'mycollection' collection instance
         var mycollection = new PlayersCollection();
         mycollection.add([country1,country2]);

         //The 'length' property defines length of the collection
         document.write('Number of added countries: ' + mycollection.length);
         document.write("<br>");

         //Here, the reset() method resets the collection otherwise empties the collection
         mycollection.reset();
         document.write('Number of countries after reset: ' + mycollection.length);
      </script>
   </body>
</html>

Output

Let us carry out the following steps to see how the above code works −

  • Save the above code in the reset.htm file.

  • Open this HTML file in a browser.

backbonejs_collection.htm
Advertisements