Click here to Skip to main content
14,382,360 members

Angular UI-Grid Pagination Server Side

Rate this:
5.00 (8 votes)
Please Sign up or sign in to vote.
5.00 (8 votes)
4 May 2016CPOL
In this post I am going to demonstrate how to use Angular UI Grid with server side pagination in ASP.Net MVC application.

Introduction

Angular UI Grid is a data grid for AngularJS without JQuery that can perform with large data, which is part of the Angular UI suite.

Background

Recently I was searching for a data table that have component like sorting, filtering, pagination, inline editor, responsive and other advance facilities. I have tried to integrate & use Jquery datatable(Angular), but the problem arise while I was trying to pass entire row passing while row click/row selected button click.

It fails to pass angular object (only can pass int, string, boolean) while render, this was a big issue to me as I was using angularJS in application frontend.

I decided to change the entire table, I found Angular UI Grid. Let’s Get Into It:

As we know Angular UI Grid is a part of Angular UI, so we have some facilities. We need to download/install package before we are going to use in our application.

To download the package, go to URL: http://ui-grid.info

Image 1

SQL Database:

CREATE TABLE [dbo].[tblProducts](
	[ProductID] [int] NOT NULL,
	[ProductTitle] [nvarchar](256) NULL,
	[Type] [nvarchar](50) NULL,
	[Price] [numeric](18, 2) NULL,
	[CreatedOn] [datetime] NULL,
 CONSTRAINT [PK_tblProducts] PRIMARY KEY CLUSTERED 
(
	[ProductID] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]

GO

Demo Data:

INSERT INTO [tblProducts]
SELECT 1,'Ape Lifestyle Cotton Casual T-Shirt - Gray','Clothing',270.00,getdate()
Union All
SELECT 2,'Cotton Casual Short Sleeve Polo - White','Clothing',790.50,getdate()
Union All
SELECT 3,'Cotton Casual Shirt - Sky Blue and White Stripe','Clothing',1555.00,getdate()
Union All
SELECT 4,'Cotton Mix Casual Panjabi - Thistle and Gray Stripe','Clothing',2458.00,getdate()
Union All
SELECT 5,'Cotton Mix Casual Panjabi - Black and Purple Stripe','Clothing',2458.00,getdate()
Union All
SELECT 6,'Cotton Casual Shirt - Red and White Check','Clothing',1735.00,getdate()
Union All
SELECT 7,'Kingstar TITANS 1 i19 Smartphone 8GB - White','Smartphone',6300.00,getdate()
Union All
SELECT 8,'MyCell Spider A4 Smartphone 8GB – White','Smartphone',7770.00,getdate()
Union All
SELECT 9,'HTC One M9S Nano-SIM Smartphone 16GB - Silver','Smartphone',26900.00,getdate()
Union All
SELECT 10,'WE X1 Smartphone 16GB – Silver','Smartphone',18600.00,getdate()
Union All
SELECT 11,'Microsoft Lumia 540 Smartphone 8GB – Cyan','Smartphone',13999.00,getdate()
Union All
SELECT 12,'BlackBerry Z10 Smartphone 16GB - White','Smartphone',18000.00,getdate()
Union All
SELECT 13,'Ape Lifestyle Cotton Casual T-Shirt - Gray','Clothing',270.00,getdate()
Union All
SELECT 14,'Cotton Casual Short Sleeve Polo - White','Clothing',790.50,getdate()
Union All
SELECT 15,'Cotton Casual Shirt - Sky Blue and White Stripe','Clothing',1555.00,getdate()
Union All
SELECT 16,'Cotton Mix Casual Panjabi - Thistle and Gray Stripe','Clothing',2458.00,getdate()
Union All
SELECT 17,'Cotton Mix Casual Panjabi - Black and Purple Stripe','Clothing',2458.00,getdate()
Union All
SELECT 18,'Cotton Casual Shirt - Red and White Check','Clothing',1735.00,getdate()
Union All
SELECT 19,'Kingstar TITANS 1 i19 Smartphone 8GB - White','Smartphone',6300.00,getdate()
Union All
SELECT 20,'MyCell Spider A4 Smartphone 8GB – White','Smartphone',7770.00,getdate()
Union All
SELECT 21,'HTC One M9S Nano-SIM Smartphone 16GB - Silver','Smartphone',26900.00,getdate()
Union All
SELECT 22,'WE X1 Smartphone 16GB – Silver','Smartphone',18600.00,getdate()
Union All
SELECT 23,'Microsoft Lumia 540 Smartphone 8GB – Cyan','Smartphone',13999.00,getdate()
Union All
SELECT 24,'BlackBerry Z10 Smartphone 16GB - White','Smartphone',18000.00,getdate()

MVC Application:

Let’s create a new demo application with visual studio 2015. Select MVC and Web API below. Click OK.Image 2

Fig: 2

After loading the initial application template, we need to install the script packages. We need to install two package using NuGet Package installer. First we will install AngularJS and after that we need to add Angular-Ui-Grid. In package manager console write Install-Package angularjs. After successfully installation write Install-Package angular-ui-grid.

Image 3

Fig: 3

Or we can install packages using NuGet package manager

AngularJS

Image 4

Fig: 4

AngularJS-uigrid

Image 5

Fig: 5

Our packages are installed, now we need to add a new controller and generate view to the application. In our master layout we need to add reference of script library.


Image 6

Fig: 6

In the head section add the ui style reference

Image 7

Fig: 7


AngularJS

Let’s add folder’s to create angular script.

Image 8

Fig: 8

 JS-Module

var app;
(function () {
    'use strict';
    app = angular.module('UIGrid_App',
        [
            'ngAnimate',                // support for CSS-based animations
            'ngTouch',                  //for touch-enabled devices
            'ui.grid',                  //data grid for AngularJS
            'ui.grid.pagination',       //data grid Pagination
            'ui.grid.resizeColumns',    //data grid Resize column
            'ui.grid.moveColumns',      //data grid Move column
            'ui.grid.pinning',          //data grid Pin column Left/Right
            'ui.grid.selection',        //data grid Select Rows
            'ui.grid.autoResize',       //data grid Enabled auto column Size
            'ui.grid.exporter'          //data grid Export Data
        ]);
})();

JS-Controller

app.controller('ProductsCtrl', ['$scope', 'CRUDService', 'uiGridConstants',
    function ($scope, CRUDService, uiGridConstants) {
        $scope.gridOptions = [];

        //Pagination
        $scope.pagination = {
            paginationPageSizes: [15, 25, 50, 75, 100, "All"],
            ddlpageSize: 15,
            pageNumber: 1,
            pageSize: 15,
            totalItems: 0,

            getTotalPages: function () {
                return Math.ceil(this.totalItems / this.pageSize);
            },
            pageSizeChange: function () {
                if (this.ddlpageSize == "All")
                    this.pageSize = $scope.pagination.totalItems;
                else
                    this.pageSize = this.ddlpageSize

                this.pageNumber = 1
                $scope.GetProducts();
            },
            firstPage: function () {
                if (this.pageNumber > 1) {
                    this.pageNumber = 1
                    $scope.GetProducts();
                }
            },
            nextPage: function () {
                if (this.pageNumber < this.getTotalPages()) {
                    this.pageNumber++;
                    $scope.GetProducts();
                }
            },
            previousPage: function () {
                if (this.pageNumber > 1) {
                    this.pageNumber--;
                    $scope.GetProducts();
                }
            },
            lastPage: function () {
                if (this.pageNumber >= 1) {
                    this.pageNumber = this.getTotalPages();
                    $scope.GetProducts();
                }
            }
        };

        //ui-Grid Call
        $scope.GetProducts = function () {
            $scope.loaderMore = true;
            $scope.lblMessage = 'loading please wait....!';
            $scope.result = "color-green";

            $scope.highlightFilteredHeader = function (row, rowRenderIndex, col, colRenderIndex) {
                if (col.filters[0].term) {
                    return 'header-filtered';
                } else {
                    return '';
                }
            };
            $scope.gridOptions = {
                useExternalPagination: true,
                useExternalSorting: true,
                enableFiltering: true,
                enableSorting: true,
                enableRowSelection: true,
                enableSelectAll: true,
                enableGridMenu: true,

                columnDefs: [
                    { name: "ProductID", displayName: "Product ID", width: '10%', headerCellClass: $scope.highlightFilteredHeader },
                    { name: "ProductTitle", title: "Product Title", width: '40%', headerCellClass: $scope.highlightFilteredHeader },
                    { name: "Type", title: "Type", headerCellClass: $scope.highlightFilteredHeader },
                    {
                        name: "Price", title: "Price", cellFilter: 'number',
                        filters: [{ condition: uiGridConstants.filter.GREATER_THAN, placeholder: 'Minimum' }, { condition: uiGridConstants.filter.LESS_THAN, placeholder: 'Maximum' }],
                        headerCellClass: $scope.highlightFilteredHeader
                    },
                    { name: "CreatedOn", displayName: "Created On", cellFilter: 'date:"short"', headerCellClass: $scope.highlightFilteredHeader },
                    {
                        name: 'Edit',
                        enableFiltering: false,
                        enableSorting: false,
                        width: '5%',
                        enableColumnResizing: false,
                        cellTemplate: '<span class="label label-warning label-mini">' +
                                      '<a href="" style="color:white" title="Select" ng-click="grid.appScope.GetByID(row.entity)">' +
                                        '<i class="fa fa-check-square" aria-hidden="true"></i>' +
                                      '</a>' +
                                      '</span>'
                    }
                ],
                exporterAllDataFn: function () {
                    return getPage(1, $scope.gridOptions.totalItems, paginationOptions.sort)
                    .then(function () {
                        $scope.gridOptions.useExternalPagination = false;
                        $scope.gridOptions.useExternalSorting = false;
                        getPage = null;
                    });
                },
            };

            var NextPage = (($scope.pagination.pageNumber - 1) * $scope.pagination.pageSize);
            var NextPageSize = $scope.pagination.pageSize;
            var apiRoute = 'api/Product/GetProducts/' + NextPage + '/' + NextPageSize;
            var result = CRUDService.getProducts(apiRoute);
            result.then(
                function (response) {
                    $scope.pagination.totalItems = response.data.recordsTotal;
                    $scope.gridOptions.data = response.data.productList;
                    $scope.loaderMore = false;
                },
            function (error) {
                console.log("Error: " + error);
            });
        }

        //Default Load
        $scope.GetProducts();

        //Selected Call
        $scope.GetByID = function (model) {
            $scope.SelectedRow = model;
        };
    }
]);

JS-Service

app.service('CRUDService', function ($http) {
    //**********----Get Record----***************
    this.getProducts = function (apiRoute) {
        return $http.get(apiRoute);
    }
});

Ui-Grid

In index.cshtml page add ui-grid directive  

Image 9

Fig: 9

The loader which will show a loading messaging while data is loading from server.  

Image 10

Fig: 10

At bottom end, add angular reference to the page  

Image 11

Fig: 11  

Complete Ui Code:

@{
    ViewBag.Title = "Products";
}

<h3>Products with UI Grid</h3>

<div class="row">
    <div class="col-md-12" ng-controller="ProductsCtrl">
        <div ui-grid="gridOptions"

             ui-grid-resize-columns

             ui-grid-move-columns

             ui-grid-exporter

             ui-grid-selection

             ui-grid-pinning class="grid"></div>

        <div class="loadmore">
            <div ng-show="loaderMore" ng-class="result">
                <img src="~/Content/ng-loader.gif" />
                {{lblMessage}}
            </div>
        </div>

        <div role="contentinfo" class="ui-grid-pager-panel ng-scope">
            <div role="navigation" class="ui-grid-pager-container">
                <div role="menubar" class="ui-grid-pager-control">
                    <!-- Start Page -->
                    <button type="button" role="menuitem" class="ui-grid-pager-first" ui-grid-one-bind-title="aria.pageToFirst"

                            ui-grid-one-bind-aria-label="aria.pageToFirst"

                            ng-click="pagination.firstPage()"

                            ng-disabled="cantPageBackward()" title="Page to first" aria-label="Page to first"

                            disabled="disabled">
                        <div class="first-triangle">
                            <div class="first-bar"></div>
                        </div>
                    </button>

                    <!-- Prev Page -->
                    <button type="button" role="menuitem" class="ui-grid-pager-previous"

                            ui-grid-one-bind-title="aria.pageBack" ui-grid-one-bind-aria-label="aria.pageBack"

                            ng-click="pagination.previousPage()"

                            ng-disabled="cantPageBackward()" title="Page back" aria-label="Page back" disabled="disabled">
                        <div class="first-triangle prev-triangle"></div>
                    </button>

                    <input type="number" ui-grid-one-bind-title="aria.pageSelected" ui-grid-one-bind-aria-label="aria.pageSelected"

                           class="ui-grid-pager-control-input ng-pristine ng-untouched ng-valid ng-not-empty ng-valid-min ng-valid-max ng-valid-required"

                           ng-model="pagination.pageNumber"

                           min="1" max="{{pagination.getTotalPages()}}" required="" title="Selected page"

                           aria-label="Selected page" disabled>

                    <span class="ui-grid-pager-max-pages-number ng-binding"

                          ng-show="pagination.getTotalPages() > 0">
                        <abbr ui-grid-one-bind-title="paginationOf" title="of"> /</abbr>{{pagination.getTotalPages()}}
                    </span>

                    <!-- Next Page -->
                    <button type="button" role="menuitem" class="ui-grid-pager-next" ui-grid-one-bind-title="aria.pageForward"

                            ui-grid-one-bind-aria-label="aria.pageForward"

                            ng-click="pagination.nextPage()"

                            ng-disabled="cantPageForward()"

                            title="Page forward" aria-label="Page forward">
                        <div class="last-triangle next-triangle"></div>
                    </button>

                    <!-- Last Page -->
                    <button type="button" role="menuitem" class="ui-grid-pager-last"

                            ui-grid-one-bind-title="aria.pageToLast" ui-grid-one-bind-aria-label="aria.pageToLast"

                            ng-click="pagination.lastPage()" ng-disabled="cantPageToLast()" title="Page to last" aria-label="Page to last">
                        <div class="last-triangle"><div class="last-bar"></div></div>
                    </button>
                </div><!-- ngIf: grid.options.paginationPageSizes.length > 1 -->

                <div class="ui-grid-pager-row-count-picker ng-scope" @*ng-if="pagination.ddlpageSize.length > 1"*@>
                    <select ng-model="pagination.ddlpageSize"

                            ng-options="o as o for o in pagination.paginationPageSizes" ng-change="pagination.pageSizeChange()"

                            class="ng-pristine ng-untouched ng-valid ng-not-empty"></select>
                    <span class="ui-grid-pager-row-count-label ng-binding">&nbsp;items per page</span>
                </div>
                <!-- end ngIf: grid.options.paginationPageSizes.length > 1 -->
                <!-- ngIf: grid.options.paginationPageSizes.length <= 1 -->
            </div>
            <div class="ui-grid-pager-count-container">
                <div class="ui-grid-pager-count">
                    <span ng-show="pagination.totalItems > 0" class="ng-binding" style="">
                        {{pagination.pageNumber}}<abbr ui-grid-one-bind-title="paginationThrough" title="through"> - </abbr>{{pagination.ddlpageSize}} of {{pagination.totalItems}} items
                    </span>
                </div>
            </div>
        </div>

        <p>{{SelectedRow}}</p>
    </div>
</div>
@section AngularScript{
    <script src="~/ScriptsNg/Controllers/ProductsCtrl.js"></script>
    <script src="~/ScriptsNg/Service/CRUDService.js"></script>
}

Model: Our Ui is ready Let’s create a new model in our demo application.  

Image 12

Fig: 12

I have used api controller to get data from server, which will get called while pagination operate. Api-Controller:

[RoutePrefix("api/Product")]
public class ProductController : ApiController
{
private dbUIGrid_Entities _ctx = null;

[HttpGet, ResponseType(typeof(tblProduct)), Route("GetProducts/{pageNumber:int}/{pageSize:int}")]
public IHttpActionResult GetProducts(int pageNumber, int pageSize)
{
    List<tblProduct> productList = null; int recordsTotal = 0;
    try
    {
        using (_ctx = new dbUIGrid_Entities())
        {
            recordsTotal = _ctx.tblProducts.Count();
            productList = _ctx.tblProducts.OrderBy(x => x.ProductID)
                                    .Skip(pageNumber)
                                    .Take(pageSize)
                                    .ToList();
        }
    }
    catch (Exception)
    {
    }
    return Json(new
    {
        recordsTotal,
        productList
    });
}
}

Final Output:  

Image 13

Fig: 13

Filter Data:

Image 14

Fig: 14

Hope this will help :)

 

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Shashangka Shekhar
Technical Lead Royal Green Ltd
Bangladesh Bangladesh
Hi, I am Shashangka Shekhar,

Working with Microsoft Technologies. Since March 2011, it was my first step to working with Microsoft Technologies, achieved bachelor’s degree on Computer Science from State University of Bangladesh(Dhaka). Have 7+ years of professional experience, currently working as Development Lead at Royal Green Ltd.

I believe in desire of learning & also love to be a part of .Net Community by sharing knowledge’s.

Comments and Discussions

 
Bugin pagination there is there is <abbr> tag showing some icon near current page. Pin
Member 1344814717-Oct-17 20:36
memberMember 1344814717-Oct-17 20:36 
QuestionExport All Data feature not working as per the code Pin
vnalluri2620-Apr-17 12:02
membervnalluri2620-Apr-17 12:02 
QuestionSorting not working Pin
Member 995554318-Jan-17 2:42
memberMember 995554318-Jan-17 2:42 
AnswerRe: Sorting not working Pin
Member 995554318-Jan-17 2:54
memberMember 995554318-Jan-17 2:54 
QuestionError in code Pin
Member 995554316-Jan-17 2:48
memberMember 995554316-Jan-17 2:48 
AnswerRe: Error in code Pin
Shashangka Shekhar16-Jan-17 5:01
mvaShashangka Shekhar16-Jan-17 5:01 
QuestionHow to add and edit on the grid Pin
ntngoc26-Dec-16 21:30
memberntngoc26-Dec-16 21:30 
AnswerRe: How to add and edit on the grid Pin
Shashangka Shekhar26-Dec-16 22:33
mvaShashangka Shekhar26-Dec-16 22:33 
QuestionErrors in code Pin
Sudipta Chaudhari14-Dec-16 20:02
memberSudipta Chaudhari14-Dec-16 20:02 
AnswerRe: Errors in code Pin
Shashangka Shekhar14-Dec-16 21:04
mvaShashangka Shekhar14-Dec-16 21:04 
Questionignore last post -wrong article -sorry Pin
Lyndon Sundmark9-May-16 11:58
memberLyndon Sundmark9-May-16 11:58 
AnswerRe: ignore last post -wrong article -sorry Pin
Shashangka Shekhar9-May-16 16:30
mvaShashangka Shekhar9-May-16 16:30 
Questiongetting error - trying to compile and run api- and i did copy config string into web config Pin
Lyndon Sundmark9-May-16 11:55
memberLyndon Sundmark9-May-16 11:55 
AnswerRe: getting error - trying to compile and run api- and i did copy config string into web config Pin
Shashangka Shekhar9-May-16 16:33
mvaShashangka Shekhar9-May-16 16:33 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

Article
Posted 4 May 2016

Tagged as

Stats

37.7K views
1.2K downloads
15 bookmarked