BackboneJS - Collection toJSON


Description

It returns the copy of the attributes hash of each model in the collection using JSON format.

Syntax

collection.toJSON(options)

Parameters

options − It includes options as the collection instance and converts it into JSON format.

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">
         //'Player' is a model and contains defualt value for the model
         var Player = Backbone.Model.extend ({
            defaults: {
               name: "sachin"
            }
         });

         //The 'PlayersCollection' is a collection instance and model 'Player' is specified by overriding 
         //the 'model' property
         var PlayersCollection = Backbone.Collection.extend ({
            model: Player
         });
         $(function() {
            var mycollection = new PlayersCollection();

            //The set() method sets the values for the 'name' attribute
            mycollection.set([
               {name: 'sehwag'},
               {name: 'raina'},
               {name: 'dhoni'}
            ]);
            
            //The JSON.stringify() method returns values of the collection in the JSON format
            document.write("The collection values are:", JSON.stringify(mycollection.toJSON()));
         });
      </script>
      
   </body>
</html>

Output

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

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

  • Open this HTML file in a browser.

backbonejs_collection.htm
Advertisements