Post
Ask Question

Create, Update or Delete List Views using JSOM in SharePoint

Introduction

The views can be created for a list with manual steps by going through the list settings. The same can be implemented programmatically using several methods. In this article, you will learn how it can be implemented using JavaScript Object Model.

For example, I have created a list called “Test” with two custom columns, Column1 and Column2. By default when you try opening a list in SharePoint, the default view called “All Items” will be rendered. This view will show you three columns. They are Title, Column1 and Column2.

 

Creating SharePoint list view using JSOM:

In this example, we will see how we can view only our custom columns by filtering the SharePoint list values.

The following flow will show you the implementation.

  1. Load the SP.js files and get the context of site

  2. Get all the views for a specific list present on the site
    1. var listCollection = web.get_lists();  
    2. list = listCollection.getByTitle("Test");  
    3. viewCollection = list.get_views();  
    4. viewContext.load(viewCollection);  
  3. Create a custom view ViewCreationInformation method. Set view title and the fields to be shown on the view using the following code.
    1. var createView = new SP.ViewCreationInformation();  
    2. createView.set_title("TestView");   
    3. var viewFields = ["Column1","Column2"];  
    4. createView.set_viewFields(viewFields);  
  4. Then build your query to retrieve the values for the view. This step can be an optional one.
    1. var camlQuery = new SP.CamlQuery();  
    2. var query = "<Where><Eq><FieldRef Name='Column1' /><Value Type='Text'>2</Value></Eq></Where>";  
    3. camlQuery.set_viewXml(query);  
    4. createView.set_query(camlQuery);
  5. The view can be limited with custom row limit.
     
    1. createView.set_rowLimit(1);  

  6. The view can be still customized with view types. The applicable types are html, grid, etc. The following code shows you how to set the type.

    1. createView.set_viewTypeKind(2048);  
    The following table shows you different types of field types with values.

     Type Value
     none 0
     html 1
     grid 2048
     calendar 524288
     recurrence 8193
     chart 131072
     gantt 67108864

  7. Then add the view to the collection and execute the query.

    1. viewCollection.add(createView);    
    2. viewContext.load(viewCollection);    
    3. viewContext.executeQueryAsync(ViewCreated, onFail);     

  8. After execution of the above approach, go to List tab and you can see the new view, “Grid View,” created. Click on the new view to see the list with necessary filters set. The following snapshot helps you to change the view.



    The below snapshot shows the data grid view of the test custom list we have created before.



    The above steps helped us in creating views for custom list.

Next we will see how we can edit the existing list views.

Modifying or Updating SharePoint list views using JSOM:

The approach is similar to creating views. Here instead of creating new view object, the existing view is retrieved and the properties are updated. The below code shows how you can update existing views.

Note: There are a few limitations in modifying views, such as the view type and view fields can’t be changed.

The following piece of code will help you in modifying the existing list view we have created above. 
  1. function UpdateViewJSOM(){  
  2.     viewContext = SP.ClientContext.get_current();  
  3.     var web = viewContext.get_web();  
  4.     var listCollection = web.get_lists();  
  5.     list = listCollection.getByTitle("Test");  
  6.     viewCollection = list.get_views();  
  7.     view = viewCollection.getByTitle("GridView");  
  8.   
  9.     var camlQuery = new SP.CamlQuery();  
  10.     var query = "<Where><Eq><FieldRef Name='Column1' /><Value Type='Text'>1</Value></Eq></Where>";  
  11.     camlQuery.set_viewXml(query);  
  12.     view.set_viewQuery(camlQuery);  
  13.     view.set_rowLimit(2);  
  14.     view.update();  
  15.     viewContext.load(view);  
  16.   
  17.     viewContext.executeQueryAsync(ViewModified,  
  18.     function onFail(sender,args){  
  19.         console.log(args.get_message());  
  20.     });  
  21. }  

The following snapshot shows the modified list view.

   

Deleting SharePoint list views using JSOM

You will learn how a list view can be deleted. This can be achieved by using deleteObject method. The below code will help you in deleting a view.

  1. function DeleteViewJSOM(){  
  2.     viewContext = SP.ClientContext.get_current();  
  3.     var web = viewContext.get_web();  
  4.     var listCollection = web.get_lists();  
  5.     list = listCollection.getByTitle("Test");  
  6.     viewCollection = list.get_views();  
  7.     view = viewCollection.getByTitle("GridView");  
  8.     view.deleteObject();      
  9.     viewContext.executeQueryAsync(ViewDeleted,  
  10.     function onFail(sender,args){  
  11.         console.log(args.get_message());  
  12.     });  
  13. }   

Summary

In this article, you have seen how a custom SharePoint list views can be created, updated, or deleted programmatically by using JavaScript Object model.

Read more articles on SharePoint:


Similar Articles