Ignite UI™ API Documentation

ui.igGridPaging

Both the igGrid and igHierarchicalGrid controls feature paging in the grid. Paging allows the grid to render a limited number of rows of the underlying set of data to the user at a time. Depending on how the grid is configured, you can choose to send all or just a sub-set of data to the client at a time. Further information regarding the classes, options, events, methods and themes of this API are available under the associated tabs above.

The following code snippet demonstrates how to initialize the igGrid control.

Click here for more information on how to get started using this API. For details on how to reference the required scripts and themes for the igGrid control read, Using JavaScript Resources in Ignite UI and Styling and Theming Ignite UI.

Code Sample

<!doctype html>
<html>
<head>
    <title>Ignite UI igGridPaging</title>
    <!-- Infragistics Combined CSS -->
    <link href="css/themes/infragistics/infragistics.theme.css" rel="stylesheet" type="text/css" />
    <link href="css/structure/infragistics.css" rel="stylesheet" type="text/css" />
    <!-- jQuery Core -->
    <script src="js/jquery.js" type="text/javascript"></script>
    <!-- jQuery UI -->
    <script src="js/jquery-ui.js" type="text/javascript"></script>
    <!-- Infragistics Combined Scripts -->
    <script src="js/infragistics.core.js" type="text/javascript"></script>
      <script src="js/infragistics.lob.js" type="text/javascript"></script>
    <script type="text/javascript">
        $(function () {
            var products = [
                { "ProductID": 1, "ProductGroup": "9001", "Name": "Adjustable Race", "ProductNumber": "AR-5381" },
                { "ProductID": 2, "ProductGroup": "9001", "Name": "Bearing Ball", "ProductNumber": "BA-8327" },
                { "ProductID": 3, "ProductGroup": "8010", "Name": "BB Ball Bearing", "ProductNumber": "BE-2349" },
                { "ProductID": 4, "ProductGroup": "9001", "Name": "Headset Ball Bearings", "ProductNumber": "BE-2908" },
                { "ProductID": 316, "ProductGroup": "8010", "Name": "Blade", "ProductNumber": "BL-2036" },
                { "ProductID": 317, "ProductGroup": "9001", "Name": "LL Crankarm", "ProductNumber": "CA-5965" },
                { "ProductID": 318, "ProductGroup": "8010", "Name": "ML Crankarm", "ProductNumber": "CA-6738" },
                { "ProductID": 319, "ProductGroup": "8010", "Name": "HL Crankarm", "ProductNumber": "CA-7457" },
                { "ProductID": 320, "ProductGroup": "9001", "Name": "Chainring Bolts", "ProductNumber": "CB-2903" }
            ];
 
            $("#grid").igGrid({
                autoGenerateColumns: true,
                dataSource: products,
                features: [{
                    name: "Paging",
                    type: "local",
                    pageSize: 5
                }]
            });
        });
    </script>
</head>
<body>
    <table id="grid">
    </table>
</body>
</html>
    

Related Samples

igGridPaging

currentPageDropDownLeadingLabel
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Leading label text for the drop down from where the page index can be switched. Use option locale.currentPageDropDownLeadingLabel.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            currentPageDropDownLeadingLabel : "Current Page"
        }
    ]
});
 
//Get
var label = $(".selector").igGridPaging("option", "currentPageDropDownLeadingLabel");
 
//Set
$(".selector").igGridPaging("option", "currentPageDropDownLeadingLabel", "Current Page");

currentPageDropDownTooltip
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Tooltip text for the page index drop down. Use option locale.currentPageDropDownTooltip.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            currentPageDropDownTooltip : "Choose Page"
        }
    ]
});
 
//Get
var tooltip = $(".selector").igGridPaging("option", "currentPageDropDownTooltip");
 
//Set
$(".selector").igGridPaging("option", "currentPageDropDownTooltip", "Choose Page");

currentPageDropDownTrailingLabel
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Trailing label text for the drop down from where the page index can be switched. Use option locale.currentPageDropDownTrailingLabel.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            currentPageDropDownTrailingLabel : "Pages"
        }
    ]
});
 
//Get
var label = $(".selector").igGridPaging("option", "currentPageDropDownTrailingLabel");
 
//Set
$(".selector").igGridPaging("option", "currentPageDropDownTrailingLabel", "Pages");

currentPageIndex

Type:: number
Default:: 0

Current page index that's bound in the data source and rendered in the UI.

Code Sample

// Initialize
$(".selector").igGrid({
    features: [
        {
            name: "Paging",
            currentPageIndex: 5
        }
    ]
});
 
//Get
var page = $(".selector").igGridPaging("option", "currentPageIndex");
 
//Set
$(".selector").igGridPaging("option", "currentPageIndex", 5);

defaultDropDownWidth

Type:: number
Default:: 70

Drop down width for the page size and page index drop downs.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            defaultDropDownWidth : 100
        }
    ]
});
 
//Get
var width = $(".selector").igGridPaging("option", "defaultDropDownWidth");
 
//Set
$(".selector").igGridPaging("option", "defaultDropDownWidth", 100);

delayOnPageChanged

Type:: number
Default:: 350

Time in milliseconds for which page drop down will wait for keystrokes before changing the page.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            delayOnPageChanged : 500
        }
    ]
});
 
//Get
var delayOnPageChanged = $(".selector").igGridPaging("option", "delayOnPageChanged");

firstPageLabelText
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Text for the first page label. Use option locale.firstPageLabelText.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            firstPageLabelText : "First"
        }
    ]
});
 
//Get
var label = $(".selector").igGridPaging("option", "firstPageLabelText");
 
//Set
$(".selector").igGridPaging("option", "firstPageLabelText", "First");

firstPageTooltip
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Tooltip text for the first page button. Use option locale.firstPageTooltip.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            firstPageTooltip : "Go to first page"
        }
    ]
});
 
//Get
var tooltip = $(".selector").igGridPaging("option", "firstPageTooltip");
 
//Set
$(".selector").igGridPaging("option", "firstPageTooltip", "Go to first page");

inherit

Type:: bool
Default:: false

Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid.

Code Sample

// Initialize
$(".selector").igHierarchicalGrid({
    features: [
        {
            name: "Paging",
            inherit: true
        }
    ]
});
 
// Get
var inherit = $(".selector").igGridPaging("option", "inherit");

language
Inherited

Type:: string
Default:: "en"

Set/Get the locale language setting for the widget.

Code Sample

    //Initialize
$(".selector").igGridPaging({
    language: "ja"
});
 
// Get
var language = $(".selector").igGridPaging("option", "language");
 
// Set
$(".selector").igGridPaging("option", "language", "ja");

lastPageLabelText
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Text for the last page label. Use option locale.lastPageLabelText.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            lastPageLabelText : "Last"
        }
    ]
});
 
//Get
var label = $(".selector").igGridPaging("option", "lastPageLabelText");
 
//Set
$(".selector").igGridPaging("option", "lastPageLabelText", "Last");

lastPageTooltip
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Tooltip text for the last page button. Use option locale.lastPageTooltip.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            lastPageTooltip : "Go to last page"
        }
    ]
});
 
//Get
var tooltip = $(".selector").igGridPaging("option", "lastPageTooltip");
 
//Set
$(".selector").igGridPaging("option", "lastPageTooltip", "Go to last page");

locale

Type:: object
Default:: {}

currentPageDropDownLeadingLabel

Type:: string
Default:: ""

Leading label text for the drop down from where the page index can be switched.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            currentPageDropDownLeadingLabel: "Current Page"
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").currentPageDropDownLeadingLabel;
 
//  Set
$(".selector").igGridPaging("option", "locale", { currentPageDropDownLeadingLabel: "Current Page" });

currentPageDropDownTooltip

Type:: string
Default:: ""

Tooltip text for the page index drop down.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            currentPageDropDownTooltip: "Choose Page"
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").currentPageDropDownTooltip;
 
//  Set
$(".selector").igGridPaging("option", "locale", { currentPageDropDownTooltip: "Choose Page" });

currentPageDropDownTrailingLabel

Type:: string
Default:: ""

Trailing label text for the drop down from where the page index can be switched.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            currentPageDropDownTrailingLabel: "Pages"
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").currentPageDropDownTrailingLabel;
 
//  Set
$(".selector").igGridPaging("option", "locale", { currentPageDropDownTrailingLabel: "Pages" });

firstPageLabelText

Type:: string
Default:: ""

Text for the first page label.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            firstPageLabelText: "First "
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").firstPageLabelText;
 
//  Set
$(".selector").igGridPaging("option", "locale", { firstPageLabelText: "First " });

firstPageTooltip

Type:: string
Default:: ""

Tooltip text for the first page button.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            firstPageTooltip: "Go to first page"
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").firstPageTooltip;
 
//  Set
$(".selector").igGridPaging("option", "locale", { firstPageTooltip: "Go to first page" });

lastPageLabelText

Type:: string
Default:: ""

Text for the last page label.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            lastPageLabelText: "Last "
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").lastPageLabelText;
 
//  Set
$(".selector").igGridPaging("option", "locale", { lastPageLabelText: "Last " });

lastPageTooltip

Type:: string
Default:: ""

Tooltip text for the last page button.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            lastPageTooltip: "Go to last page"
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").lastPageTooltip;
 
//  Set
$(".selector").igGridPaging("option", "locale", { lastPageTooltip: "Go to last page" });

nextPageLabelText

Type:: string
Default:: ""

Text for the next page label.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            nextPageLabelText: "Next "
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").nextPageLabelText;
 
//  Set
$(".selector").igGridPaging("option", "locale", { nextPageLabelText: "Next " });

nextPageTooltip

Type:: string
Default:: ""

Tooltip text for the next page button.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            pageTooltipFormat: "Go to next page"
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").pageTooltipFormat;
 
//  Set
$(".selector").igGridPaging("option", "locale", { pageTooltipFormat: "Go to next page" });

pagerRecordsLabelTemplate

Type:: string
Default:: ""

Custom pager records label template - in igTemplating style and syntax.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            pagerRecordsLabelTemplate: "From ${startRecord} to ${endRecord} of ${recordCount}"
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").pagerRecordsLabelTemplate;
 
//  Set
$(".selector").igGridPaging("option", "locale", { pagerRecordsLabelTemplate: "From ${startRecord} to ${endRecord} of ${recordCount}" });

pagerRecordsLabelTooltip

Type:: string
Default:: ""

Tooltip text for the pager records label.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            pagerRecordsLabelTooltip: "Current records"
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").pagerRecordsLabelTooltip;
 
//  Set
$(".selector").igGridPaging("option", "locale", { pagerRecordsLabelTooltip: "Current records" });

pageSizeDropDownLabel

Type:: string
Default:: ""

Text rendered in front of the page size dropdown, when showPageSizeDropDown is set to true.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            pageSizeDropDownLabel: "Show "
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").pageSizeDropDownLabel;
 
//  Set
$(".selector").igGridPaging("option", "locale", { pageSizeDropDownLabel: "Show " });

pageSizeDropDownTooltip

Type:: string
Default:: ""

Tooltip text for the page size drop down.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            pageSizeDropDownTooltip: "Choose page size"
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").pageSizeDropDownTooltip;
 
//  Set
$(".selector").igGridPaging("option", "locale", { pageSizeDropDownTooltip: "Choose page size" });

pageSizeDropDownTrailingLabel

Type:: string
Default:: ""

Trailing text for the page size dropdown, when showPageSizeDropDown is set to true.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            pageSizeDropDownTrailingLabel: "Show "
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").pageSizeDropDownTrailingLabel;
 
//  Set
$(".selector").igGridPaging("option", "locale", { pageSizeDropDownTrailingLabel: "Show " });

pageTooltipFormat

Type:: string
Default:: ""

Tooltip text templates of buttons that navigate to a particular page. The format string follows the igTemplating style and syntax.
See also the pageCountLimit option.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            pageTooltipFormat: "Page ${index}"
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").pageTooltipFormat;
 
//  Set
$(".selector").igGridPaging("option", "locale", { pageTooltipFormat: "Page ${index}" });

prevPageLabelText

Type:: string
Default:: ""

Text for the previous page label.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            prevPageLabelText: "Previous "
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").prevPageLabelText;
 
//  Set
$(".selector").igGridPaging("option", "locale", { prevPageLabelText: "Previous " });

prevPageTooltip

Type:: string
Default:: ""

Tooltip text for the previous page button.

Code Sample

//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        locale: {
            prevPageTooltip: "Go to previous page"
        }
    }]
});
 
//  Get
var text = $(".selector").igGridPaging("option", "locale").prevPageTooltip;
 
//  Set
$(".selector").igGridPaging("option", "locale", { prevPageTooltip: "Go to previous page" });

nextPageLabelText
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Text for the next page label. Use option locale.nextPageLabelText.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            nextPageLabelText : "Next"
        }
    ]
});
 
//Get
var label = $(".selector").igGridPaging("option", "nextPageLabelText");
 
//Set
$(".selector").igGridPaging("option", "nextPageLabelText", "Next");

nextPageTooltip
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Tooltip text for the next page button. Use option locale.nextPageTooltip.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            nextPageTooltip : "Go to next page"
        }
    ]
});
 
//Get
var tooltip = $(".selector").igGridPaging("option", "nextPageTooltip");
 
//Set
$(".selector").igGridPaging("option", "nextPageTooltip", "Go to next page");

pageCountLimit

Type:: number
Default:: 10

Sets/Gets the number of pages which if exceeded a drop down list of page indices is displayed. If the number of pages is less than or equal to this option then buttons for each page are displayed.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            pageCountLimit : 5
        }
    ]
});
 
//Get
var count = $(".selector").igGridPaging("option", "pageCountLimit");
 
//Set
$(".selector").igGridPaging("option", "pageCountLimit", 5);

pageIndexUrlKey

Type:: string
Default:: null

Denotes the name of the encoded URL parameter that will state what is the currently requested page index.

Code Sample

// Initialize
$(".selector").igGrid({
    features: [
        {
            name: "Paging",
            pageIndexUrlKey: "page"
        }
    ]
});
 
//Get
var key = $(".selector").igGridPaging("option", "pageIndexUrlKey");
 
//Set
$(".selector").igGridPaging("option", "pageIndexUrlKey", "page");

pagerRecordsLabelTemplate
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Custom pager records label template - in igTemplating style and syntax.
Use option locale.pagerRecordsLabelTemplate.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            pagerRecordsLabelTemplate : "From ${startRecord} to ${endRecord} of ${recordCount}"
        }
    ]
});
 
//Get
var labelTemplate = $(".selector").igGridPaging("option", "pagerRecordsLabelTemplate");
 
//Set
$(".selector").igGridPaging("option", "pagerRecordsLabelTemplate", "From ${startRecord} to ${endRecord} of ${recordCount}");

pagerRecordsLabelTooltip
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Tooltip text for the pager records label. Use option locale.pagerRecordsLabelTooltip.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            pagerRecordsLabelTooltip : "Current records"
        }
    ]
});
 
//Get
var labelTemplate = $(".selector").igGridPaging("option", "pagerRecordsLabelTooltip");
 
//Set
$(".selector").igGridPaging("option", "pagerRecordsLabelTooltip", "Current records");

pageSize

Type:: number
Default:: 25

Number of records loaded and displayed per page.

Code Sample

// Initialize
$(".selector").igGrid({
    features: [
        {
            name: "Paging",
            pageSize: 10
        }
    ]
});
 
//Get
var pageSize = $(".selector").igGridPaging("option", "pageSize");
 
//Set
$(".selector").igGridPaging("option", "pageSize", 10);

pageSizeDropDownLabel
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Text rendered in front of the page size dropdown, when showPageSizeDropDown is set to true.
Use option locale.pageSizeDropDownLabel.

Code Sample

// Initialize
$(".selector").igGrid({
    features: [
        {
            name: "Paging",
            pageSizeDropDownLabel: "Rows"
        }
    ]
});
 
//Get
var label = $(".selector").igGridPaging("option", "pageSizeDropDownLabel");
 
//Set
$(".selector").igGridPaging("option", "pageSizeDropDownLabel", "Rows");

pageSizeDropDownLocation

Type:: enumeration
Default:: above

Page size dropdown location, when showPageSizeDropDown is set to true. Can be rendered above the grid header or inside the pager, next to the page links.

Members

above
Type:string
The page size drop down will be rendered above the grid header.
inpager
Type:string
The page size drop down will be rendered next to page links.

Code Sample

// Initialize
$(".selector").igGrid({
    features: [
        {
            name: "Paging",
            pageSizeDropDownLocation: "inpager"
        }
    ]
});
//Get
var location = $(".selector").igGridPaging("option", "pageSizeDropDownLocation");
//Set
$(".selector").igGridPaging("option", "pageSizeDropDownLocation", "inpager");

pageSizeDropDownTooltip
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Tooltip text for the page size drop down. Use option locale.pageSizeDropDownTooltip.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            pageSizeDropDownTooltip : "Choose page size"
        }
    ]
});
 
//Get
var tooltip = $(".selector").igGridPaging("option", "pageSizeDropDownTooltip");
 
//Set
$(".selector").igGridPaging("option", "pageSizeDropDownTooltip", "Choose page size");

pageSizeDropDownTrailingLabel
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Trailing text for the page size dropdown, when showPageSizeDropDown is set to true.
Use option locale.pageSizeDropDownTrailingLabel.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            pageSizeDropDownTrailingLabel : "Rows"
        }
    ]
});
 
//Get
var label = $(".selector").igGridPaging("option", "pageSizeDropDownTrailingLabel");
 
//Set
$(".selector").igGridPaging("option", "pageSizeDropDownTrailingLabel", "Rows");

pageSizeList

Type:: enumeration
Default:: []

Predefined page sizes that are available to the end user to switch their grid paging to, through a drop down in the grid header.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            pageSizeList : [10, 20, 30]
        }
    ]
});
//Get
var pagesList = $(".selector").igGridPaging("option", "pageSizeList");
//Set
$(".selector").igGridPaging("option", "pageSizeList", "10,20,30,40");

pageSizeUrlKey

Type:: string
Default:: null

Denotes the name of the encoded URL parameter that will state what is the currently requested page size.

Code Sample

// Initialize
$(".selector").igGrid({
    features: [
        {
            name: "Paging",
            pageSizeUrlKey: "psize"
        }
    ]
});
 
//Get
var key = $(".selector").igGridPaging("option", "pageSizeUrlKey");
 
//Set
$(".selector").igGridPaging("option", "pageSizeUrlKey", "psize");

pageTooltipFormat
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Tooltip text templates of buttons that navigate to a particular page. The format string follows the igTemplating style and syntax. See also the pageCountLimit option.
Use option locale.pageTooltipFormat.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            pageTooltipFormat : "Open page"
        }
    ]
});
 
//Get
var key = $(".selector").igGridPaging("option", "pageTooltipFormat");
 
//Set
$(".selector").igGridPaging("option", "pageTooltipFormat", "Open page");

persist

Type:: bool
Default:: true

Enables/disables paging persistence between states.

Code Sample

//Initialize
$(".selector").igGrid({
features : [
    {
        name : "Paging",
        persist : false
    }
]
});
 
//Get
var persist = $(".selector").igGridPaging("option", "persist");
 
//Set
$(".selector").igGridPaging("option", "persist", true);

prevPageLabelText
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Text for the previous page label. Use option locale.prevPageLabelText.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            prevPageLabelText : "Previous"
        }
    ]
});
 
//Get
var label = $(".selector").igGridPaging("option", "prevPageLabelText");
 
//Set
$(".selector").igGridPaging("option", "prevPageLabelText", "Previous");

prevPageTooltip
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Tooltip text for the previous page button. Use option locale.prevPageTooltip.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            prevPageTooltip : "Go to previous page"
        }
    ]
});
 
//Get
var tooltip = $(".selector").igGridPaging("option", "prevPageTooltip");
 
//Set
$(".selector").igGridPaging("option", "prevPageTooltip", "Go to previous page");

recordCountKey

Type:: string
Default:: null

The property in the response data, when using remote data source, that will hold the total number of records in the data source.

Code Sample

// Initialize
$(".selector").igGrid({
    features: [
        {
            name: "Paging",
            recordCountKey: "totalCount"
        }
    ]
});
 
//Get
var totalCount = $(".selector").igGridPaging("option", "recordCountKey");
 
//Set
$(".selector").igGridPaging("option", "recordCountKey", "totalCount");

regional
Inherited

Type:

enumeration

Default:

defaults

Set/Get the regional setting for the widget.

Code Sample

//Initialize
$(".selector").igGridPaging({
regional: "ja"
});
// Get
var regional = $(".selector").igGridPaging("option", "regional");
// Set
$(".selector").igGridPaging("option", "regional", "ja");

showFirstLastPages

Type:: bool
Default:: true

Option specifying whether to render the first and last page navigation buttons.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            showFirstLastPages : false
        }
    ]
});
 
//Get
var showFirstLast = $(".selector").igGridPaging("option", "showFirstLastPages");
 
//Set
$(".selector").igGridPaging("option", "showFirstLastPages", false);

showPagerRecordsLabel

Type:: bool
Default:: true

Option specifying whether to show summary label for the currently rendered records or not.

Code Sample

// Initialize
$(".selector").igGrid({
    features: [
        {
            name: "Paging",
            showPagerRecordsLabel: false
        }
    ]
});
 
//Get
var showRecordsLabel = $(".selector").igGridPaging("option", "showPagerRecordsLabel");
 
//Set
$(".selector").igGridPaging("option", "showPagerRecordsLabel", false);

showPageSizeDropDown

Type:: bool
Default:: true

If false, a dropdown allowing to change the page size will not be rendered in the UI.

Code Sample

// Initialize
$(".selector").igGrid({
    features: [
        {
            name: "Paging",
            showPageSizeDropDown: false
        }
    ]
});
 
//Get
var showDropDown = $(".selector").igGridPaging("option", "showPageSizeDropDown");
 
//Set
$(".selector").igGridPaging("option", "showPageSizeDropDown", false);

showPrevNextPages

Type:: bool
Default:: true

Option specifying whether to render the previous and next page navigation buttons.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            showPrevNextPages : false
        }
    ]
});
 
//Get
var showPages = $(".selector").igGridPaging("option", "showPrevNextPages");
 
//Set
$(".selector").igGridPaging("option", "showPrevNextPages", false);

type

Type:: enumeration
Default:: null

Type of paging. Delegates all paging functionality to the $.ig.DataSource.

Members

remote
Type:string
Paging is performed by a remote end-point.
local
Type:string
Paging is performed locally by the $.ig.DataSource.

Code Sample

// Initialize
$(".selector").igGrid({
    features: [
        {
            name: "Paging",
            type: "local"
        }
    ]
});
//Get
var type = $(".selector").igGridPaging("option", "type");
//Set
$(".selector").igGridPaging("option", "type", "local");

visiblePageCount

Type:: number
Default:: 5

Number of page buttons, adjacent to and including the active page, that are constantly visible. For the invisible pages, previous and next buttons are used.

Code Sample

//Initialize
$(".selector").igGrid({
    features : [
        {
            name : "Paging",
            visiblePageCount : 10
        }
    ]
});
 
//Get
var visCount = $(".selector").igGridPaging("option", "visiblePageCount");
 
//Set
$(".selector").igGridPaging("option", "visiblePageCount", 10);

For more information on how to interact with the Ignite UI controls' events, refer to
Using Events in Ignite UI.

Note: Calling API methods programmatically does not raise events related to their operation unless specifically stated otherwise by the corresponding API documentation; those events are only raised by their respective user interaction.

Show Details

pageIndexChanged

Cancellable:: false

Event fired after the page index is changed , but before grid data rebinds.

evt
Type: Event

JQuery event object.
ui
Type: Object

Code Sample

//Bind after initialization
$(document).on("iggridpagingpageindexchanged", ".selector", function (evt, ui) {
    //return browser event
    evt.originalEvent;
 
    //  Get a reference to the igGridPaging widget that fired the event
    ui.owner;
 
    //  Get a reference to the igGrid widget to which the igGridPaging is bound
    ui.owner.grid;
 
    //  Get the current page index
    ui.pageIndex;
});
 
//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        pageIndexChanged: function (evt, ui) { ... }
    }]
});

pageIndexChanging

Cancellable:: true

Event fired before the page index is changed.
Return false in order to cancel page index changing.

evt
Type: Event

JQuery event object.
ui
Type: Object

Code Sample

//Bind after initialization
$(document).on("iggridpagingpageindexchanging", ".selector", function (evt, ui) {
    //return browser event
    evt.originalEvent;
 
    //  Get a reference to the igGridPaging widget that fired the event
    ui.owner;
 
    //  Get a reference to the igGrid widget to which the igGridPaging is bound
    ui.owner.grid;
 
    //  Get the current page index
    ui.currentPageIndex;
 
    //  Get the index of the page that is about to be opened
    ui.newPageIndex;
});
 
//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        pageIndexChanging: function (evt, ui) { ... }
    }]
});

pagerRendered

Cancellable:: false

Event fired after the pager footer is rendered.

evt
Type: Event

JQuery event object.
ui
Type: Object

Code Sample

//Bind after initialization
$(document).on("iggridpagingpagerrendered", ".selector", function (evt, ui) {
    //return browser event
    evt.originalEvent;
 
    //  Get a reference to the igGridPaging widget that fired the event
    ui.owner;
 
    //  Get a reference to the igGrid widget to which the igGridPaging is bound
    ui.owner.grid;
 
    //  Get the data source of the grid
    ui.dataSource;
});
 
//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        pagerRendered: function (evt, ui) { ... }
    }]
});

pagerRendering

Cancellable:: true

Event fired before the pager footer is rendered (the whole area below the grid records).
Event fired after the page size is changed from the page size dropdown.

evt
Type: Event

JQuery event object.
ui
Type: Object

Code Sample

//Bind after initialization
$(document).on("iggridpagingpagerrendering", ".selector", function (evt, ui) {
    //return browser event
    evt.originalEvent;
 
    //  Get a reference to the igGridPaging widget that fired the event
    ui.owner;
 
    //  Get a reference to the igGrid widget to which the igGridPaging is bound
    ui.owner.grid;
 
    //  Get the data source of the grid
    ui.dataSource;
});
 
//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        pagerRendering: function (evt, ui) { ... }
    }]
});

pageSizeChanged

Cancellable:: false

Event fired after the page size is changed from the page size dropdown.

evt
Type: Event

JQuery event object.
ui
Type: Object

Code Sample

//Bind after initialization
$(document).on("iggridpagingpagesizechanged", ".selector", function (evt, ui) {
    //return browser event
    evt.originalEvent;
 
    //  Get a reference to the igGridPaging widget that fired the event
    ui.owner;
 
    //  Get a reference to the igGrid widget to which the igGridPaging is bound
    ui.owner.grid;
 
    //  Get the current page size in the grid
    ui.pageSize;
});
 
//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        pageSizeChanged: function (evt, ui) { ... }
    }]
});

pageSizeChanging

Cancellable:: true

Event fired when the page size is about to be changed from the page size dropdown.
Return false in order to cancel page size changing.

evt
Type: Event

JQuery event object.
ui
Type: Object

Code Sample

//Bind after initialization
$(document).on("iggridpagingpagesizechanging", ".selector", function (evt, ui) {
    //return browser event
    evt.originalEvent;
 
    //  Get a reference to the igGridPaging widget that fired the event
    ui.owner;
 
    //  Get a reference to the igGrid widget to which the igGridPaging is bound
    ui.owner.grid;
 
    //  Get the current page size in the grid
    ui.currentPageSize;
 
    //  Get the new page size in the grid that is about to be set
    ui.newPageSize;
});
 
//Initialize
$(".selector").igGrid({
    features: [{
        name: "Paging",
        pageSizeChanging: function (evt, ui) { ... }
    }]
});

Show Details

changeLocale

.igGridPaging( "changeLocale" );
Changes the all locales into the widget element to the language specified in options.language
Note that this method is for rare scenarios, see language or locale option setter.
Code Sample

$(".selector").igGridPaging("changeLocale");
destroy

.igGridPaging( "destroy" );
Destroys the igGridPaging feature by removing all elements in the pager area, unbinding events, and resetting data to discard data filtering on paging.
Code Sample

$(".selector").igGridPaging("destroy");
pageIndex

.igGridPaging( "pageIndex", [index:number] );

Return Type:

number

Return Type Description:

If no param is specified, returns the current page index.
Gets/Sets the current page index, delegates data binding and paging to $.ig.DataSource.
- index
- Type:number
- Optional
- The page index to go to.
Code Sample

//Get
var index = $(".selector").igGridPaging("pageIndex");

//Set
$(".selector").igGridPaging("pageIndex", 4);
pageSize

.igGridPaging( "pageSize", [size:number] );

Return Type:

number

Return Type Description:

If no param is specified, returns the current page size.
Gets/Sets the page size. If no parameter is specified, just returns the current page size.
- size
- Type:number
- Optional
- The new page size.
Code Sample

//Get
var size = $(".selector").igGridPaging("pageSize");

//Set
$(".selector").igGridPaging("pageSize", 16);

ui-iggrid-firstpage ui-iggrid-paging-item ui-state-default ui-corner-left

Classes applied to the area where the first page button and label are rendered.
ui-iggrid-pageimg ui-iggrid-firstpageimg ui-icon ui-icon-arrowstop-1-w

Classes applied to the first page area that holds the span for the icon.
ui-iggrid-pageimg ui-iggrid-firstpageimgdisabled ui-icon ui-state-disabled ui-icon-arrowstop-1-w

Classes applied to the first page area that holds the span for the icon when it is disabled.
ui-iggrid-firstpagelabel

Classes applied to the first page's label (span).
ui-iggrid-firstpagelabeldisabled ui-state-disabled

Classes applied to the first page's label (span) when it's disabled.
ui-iggrid-lastpage ui-iggrid-paging-item ui-state-default ui-corner-right

Classes applied to the area where the last page button and label are rendered.
ui-iggrid-pageimg ui-iggrid-lastpageimg ui-icon ui-icon-arrowstop-1-e

Classes applied to the last page area that holds the span for the icon.
ui-iggrid-pageimg ui-iggrid-lastpageimgdisabled ui-icon ui-state-disabled ui-icon-arrowstop-1-e

Classes applied to the last page area that holds the span for the icon when it is disabled.
ui-iggrid-lastpagelabel

Classes applied to the last page's label (span).
ui-iggrid-lastpagelabeldisabled ui-state-disabled

Classes applied to the last page's label (span) when it's disabled.
ui-iggrid-nextpage ui-iggrid-paging-item ui-state-default

Classes applied to the area where the next page button and label are rendered.
ui-iggrid-pageimg ui-iggrid-nextpageimg ui-icon ui-icon-triangle-1-e

Classes applied to the next page area that holds the span for the icon.
ui-iggrid-pageimg ui-iggrid-nextpageimgdisabled ui-icon ui-state-disabled ui-icon-triangle-1-e

Classes applied to the next page area that holds the span for the icon when it is disabled.
ui-iggrid-nextpagelabel

Classes applied to the next page's label (span).
ui-iggrid-nextpagelabeldisabled ui-state-disabled

Classes applied to the next page's label (span) when it's disabled.
ui-iggrid-page ui-state-default ui-corner-all

Classes applied to a page container element (list item).
ui-iggrid-pagecurrent ui-state-active ui-corner-all

Clases applied to the current page (corresponding to the current page index).
ui-iggrid-pagedropdown

Classes applied to the editor dropdown from where the page index can be changed.
ui-iggrid-pagedropdowncontainer

Classes applied to the element holding the editor dropdown from where the page index can be changed.
ui-iggrid-pagedropdownlabels

Classes applied to the spans that are before and after the dropdown editor from where the page index can be changed.
ui-iggrid-pagefocused ui-state-focus

Classes applied to the current page that has focus (when keyboard anvigation is used).
ui-iggrid-page-hover ui-state-hover

Classes applied to a page list item when it's hovered.
ui-iggrid-pagelink ui-helper-reset

Classes applied to a page link that can be clicked with the mouse.
ui-iggrid-pagelinkcurrent

Classes applied to the anchor of the current page item.
ui-helper-reset ui-iggrid-pagelist ui-iggrid-paging-item

Classes applied to the UL list that holds all pages.
ui-widget ui-iggrid-pager ui-helper-clearfix ui-corner-bottom ui-widget-header ui-iggrid-footer

Classes applied to the pager area.
ui-iggrid-pagerrecordslabel ui-iggrid-results

Classes applied to the label showing how many records are rendered of some total number.
ui-iggrid-paging

Classes applied to the area on the right of the footer where first, last, prev, next buttons as well as page links and page index dropdown are rendered.
ui-iggrid-pagesizedropdown

Classes applied to the editor dropdown from where page size can be changed.
ui-helper-clearfix ui-iggrid-pagesizedropdowncontainer

Classes applied to the element that holds the page size dropdown.
ui-widget ui-helper-clearfix ui-iggrid-pagesizedropdowncontainerabove ui-iggrid-toolbar ui-widget-header and ui-corner-top

Classes applied to the container of the page size dropdown editor, when it is rendered above the header.
ui-iggrid-pagesizelabel

Classes applied to the editor dropdown label from where page size can be changed.
ui-iggrid-results

Classes applied around the label showing the currently rendered record indices out of some total value.
ui-iggrid-prevpage ui-iggrid-paging-item ui-state-default

Classes applied to the area where the prev page button and label are rendered.
ui-iggrid-pageimg ui-iggrid-prevpageimg ui-icon ui-icon-triangle-1-w

Classes applied to the prev page area that holds the span for the icon.
ui-iggrid-pageimg ui-iggrid-prevpageimgdisabled ui-icon ui-state-disabled ui-icon-triangle-1-w

Classes applied to the prev page area that holds the span for the icon when it is disabled.
ui-iggrid-prevpagelabel

Classes applied to the prev page's label (span).
ui-iggrid-prevpagelabeldisabled ui-state-disabled

Classes applied to the prev page's label (span) when it's disabled.

Ignite UI for jQuery | API Reference

ui.igGridPaging

Code Sample

Related Samples

Related Topics

Dependencies

Inherits