ui.igGrid

ui.igGrid_image

The igGrid control is a jQuery grid that includes user interaction features like filtering, grouping, column hiding and resizing, paging, row and cell selection, sorting, summaries, tooltips, and data editing capabilities.

Note: The igGrid is a stand-alone control as well as the base for the igHierarchicalGrid control. Each API that applies to igGrid also applies to the igHierarchicalGrid control.

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>
            <!-- 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">
                var products = [
                    { "ProductID": 1, "Name": "Adjustable Race", "ProductNumber": "AR-5381", "Category": { "ID": 0, "Name": "Food", "Active": true, "Date": "\/Date(1059660800000)\/" } },
                    { "ProductID": 2, "Name": "Bearing Ball", "ProductNumber": "BA-8327", "Category": { "ID": 1, "Name": "Beverages", "Active": true, "Date": "\/Date(1159660800000)\/" } },
                    { "ProductID": 3, "Name": "BB Ball Bearing", "ProductNumber": "BE-2349", "Category": { "ID": 1, "Name": "Beverages", "Active": true, "Date": "\/Date(1259660800000)\/" } },
                    { "ProductID": 4, "Name": "Headset Ball Bearings", "ProductNumber": "BE-2908", "Category": { "ID": 1, "Name": "Beverages", "Active": true, "Date": "\/Date(1359660800000)\/" } },
                    { "ProductID": 316, "Name": "Blade", "ProductNumber": "BL-2036", "Category": { "ID": 1, "Name": "Beverages", "Active": false, "Date": "\/Date(1459660800000)\/" } },
                    { "ProductID": 317, "Name": "LL Crankarm", "ProductNumber": "CA-5965", "Category": { "ID": 1, "Name": "Beverages", "Active": false, "Date": "\/Date(1559660800000)\/" } },
                    { "ProductID": 318, "Name": "ML Crankarm", "ProductNumber": "CA-6738", "Category": { "ID": 1, "Name": "Beverages", "Active": false, "Date": "\/Date(1659660800000)\/" } },
                    { "ProductID": 319, "Name": "HL Crankarm", "ProductNumber": "CA-7457", "Category": { "ID": 2, "Name": "Electronics", "Active": false, "Date": "\/Date(1759660800000)\/" } },
                    { "ProductID": 320, "Name": "Chainring Bolts", "ProductNumber": "CB-2903", "Category": { "ID": 2, "Name": "Electronics", "Active": false, "Date": "\/Date(1859660800000)\/" } }
               ];

               $(function () {
                   $("#grid").igGrid({
                       columns: [
                           { headerText: "Product ID", key: "ProductID", dataType: "number" },
                           { headerText: "Product Name", key: "Name", dataType: "string" },
                           { headerText: "Product Number", key: "ProductNumber", dataType: "string" }
                       ],
                       width: "500px",
                       dataSource: products
                   });
               });
            </script>
        </head>
        <body>
            <table id="grid"></table>
        </body>
        </html>
      

Related Samples

Related Topics

Dependencies

jquery-1.9.1.js
jquery.ui.core.js
jquery.ui.widget.js
infragistics.datasource.js
infragistics.ui.shared.js
infragistics.templating.js
infragistics.util.js

Inherits

  • adjustVirtualHeights

    Type:
    bool
    Default:
    false

    If this option is set to true, the height of the grid row will be calculated automatically based on the avgRowHeight and the visible virtual records. If no avgRowHeight is specified, it will be calculated automatically at runtime.

    Code Sample

     
    				// Initialize
    				$(".selector").igGrid({
    					adjustVirtualHeights : true
    				});
    
    				// Get
    				var virtualHeights = $(".selector").igGrid("option", "adjustVirtualHeights");
    			 
  • aggregateTransactions

    Type:
    bool
    Default:
    false

    If set to true, the following behavior will take place:
    If a new row is added, and then deleted, there will be no transaction added to the log.
    If a new row is added, edited, then deleted, there will be no transaction added to the log.
    If several edits are made to a row or an individual cell, this should result in a single transaction.
    Note: This option takes effect only when autoCommit is set to false.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					aggregateTransactions : true
    				});
    
    				//Get
    				var aggregateTransactions = $(".selector").igGrid("option", "aggregateTransactions");
    			 
  • alternateRowStyles

    Type:
    bool
    Default:
    true

    Enables/disables rendering of alternating row styles (odd and even rows receive different styling).

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					alternateRowStyles : true;
    				});
    
    				//Get
    				var rowAltStyles = $(".selector").igGrid("option", "alternateRowStyles");
    
    				//Set
    				$(".selector").igGrid("option", "alternateRowStyles", true);
    			 
  • autoAdjustHeight

    Type:
    bool
    Default:
    true

    If autoAdjustHeight is set to false, the height will be set only on the scrolling container, and all other UI elements such as paging footer / filter row / headers will add on top of that, so the total height of the grid will be more than this value - the height of the scroll container (content area) will not be dynamically calculated. Setting this option to false will usually result in a lot better initial rendering performance for large data sets ( > 1000 rows rendered at once, no virtualization enabled), since no reflows will be made by browsers when accessing DOM properties such as offsetHeight.

    Code Sample

     
    				// Initialize
    				$(".selector").igGrid({
    					autoAdjustHeight : false
    				});
    
    				// Get
    				var adjustHeight = $(".selector").igGrid("option", "autoAdjustHeight");
    			 
  • autoCommit

    Type:
    bool
    Default:
    false

    Automatically commits the transactions as rows/cells are being edited to the client data source. A saveChanges call still needs to be performed in order to commit the transactions to a server-side data source.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					autoCommit : true
    				});
    
    				//Get
    				var commit = $(".selector").igGrid("option", "autoCommit");
    			 
  • autofitLastColumn

    Type:
    bool
    Default:
    true

    If set to true and all columns' widths are specified and their combined width is less than the grid width then the last column width will be automatically adjusted to fill the remaining empty space of the grid.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					autofitLastColumn : true
    				});
    
    				//Get
    				var autoFit = $(".selector").igGrid("option", "autofitLastColumn");
    			 
  • autoFormat

    Type:
    enumeration
    Default:
    date

    Sets gets ability to automatically format text in cells for numeric and date columns. The format patterns and rules for numbers and dates are defined in $.ig.regional.defaults object. Here column formatting is explained in details.

    Members

    • date
    • Type:string
    • formats only Date columns.
    • number
    • Type:string
    • formats only number columns.
    • dateandnumber
    • Type:string
    • formats both Date and number columns.
    • true
    • Type:bool
    • formats Date and number columns.
    • false
    • Type:bool
    • auto formatting is disabled.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					autoFormat : "number"
    				});
    				//Get
    				var autoFormat = $(".selector").igGrid("option", "autoFormat");
    			 
  • autoGenerateColumns

    Type:
    bool
    Default:
    true

    If no columns collection is defined, and autoGenerateColumns is set to true, columns will be inferred from the data source before the dataRendering event is fired. The inferred columns collection will be available to the developer for modification at dataRendering. If autoGenerateColumns is not explicitly set and columns has at least one column defined then autoGenerateColumns is automatically set to false.
    If autoGenerateColumns is true and there are columns defined auto-generated columns will render after the explicitly defined ones.
    Since auto-generated columns don't have width defined consider setting defaultColumnWidth as well.

    Code Sample

     
    				// Initialize
    				$(".selector").igGrid({
    					autoGenerateColumns : false
    				});
    
    				// Get
    				var autoCols = $(".selector").igGrid("option", "autoGenerateColumns");
    			 
  • avgColumnWidth

    Type:
    enumeration
    Default:
    null

    Used for column virtualization in fixed mode. This is the average value in pixels for a column width.

    Members

    • string
    • Type:string
    • The avarage column width can be set in pixels ("25px").
    • number
    • Type:number
    • The avarage column width can be set in pixels as a number (25).

    Code Sample

     
    				// Initialize
    				$(".selector").igGrid({
    					avgColumnWidth : "100px"
    				});
    				// Get
    				var width = $(".selector").igGrid("option", "avgColumnWidth");
    			 
  • avgRowHeight

    Type:
    enumeration
    Default:
    25

    Used for row virtualization in fixed mode. This is the average value in pixels (default) that will be used to calculate how many rows to render as the end user scrolls. Also all rows' height will be automatically set to this value.

    Members

    • string
    • Type:string
    • The avarage row height can be set in pixels ("25px").
    • number
    • Type:number
    • The avarage row height can be set in pixels as a number (25).

    Code Sample

     
    				// Initialize
    				$(".selector").igGrid({
    					avgRowHeight : "35px"
    				});
    				// Get
    				var height = $(".selector").igGrid("option", "avgRowHeight");
    			 
  • caption

    Type:
    string
    Default:
    null

    Caption text that will be shown above the grid header.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					caption : "Sales Data"
    				});
    
    				//Get
    				var caption = $(".selector").igGrid("option", "caption");
    
    				//Set
    				$(".selector").igGrid("option", "caption", "Sales Data");
    			 
  • columns

    Type:
    array
    Default:
    []
    Elements Type:
    object

    An array of column objects. Checkout the Columns and Layout topic for details on configuring the columns array.

    Code Sample

     
    				// Initialize
    				$(".selector").igGrid({
    					autoGenerateColumns: false,
    			columns: [
    						{ headerText: "Product ID", key: "ProductID", dataType: "number" },
    						{ headerText: "Product Name", key: "Name", dataType: "string" },
    						{ headerText: "ProductNumber", key: "ProductNumber", dataType: "string" },
    						{ headerText: "Color", key: "Color", dataType: "string" },
    						{ headerText: "StandardCost", key: "StandardCost", dataType: "number" },
    					]
    				});
    
    				// Get
    				var cols = $(".selector").igGrid("option", "columns");
    
    				// Set
    				var newColumn = { headerText: "New Column", key: "NewCol" };
    				cols.push(newColumn);
    				$(".selector").igGrid("option", "columns", cols);
    			 
    • colSpan

      Type:
      number
      Default:
      1

      Specifies the colSpan of the cell in a Multi-Row Layout configuration. colSpan 0 is not supported and will be changed to 1 by the grid. Here you can find more about the Multi-Row Layout feature.

      Code Sample

       
      						//Initialize
      						$(".selector").igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{ headerText: "Product ID", key: "ProductID", dataType: "number" },
      								{ headerText: "Product Name", key: "Name", dataType: "string", colSpan: 2 },
      								{ headerText: "ProductNumber", key: "ProductNumber", dataType: "string" },
      								{ headerText: "Color", key: "Color", dataType: "string" },
      								{ headerText: "StandardCost", key: "StandardCost", dataType: "number", colSpan: 2 },
      							]
      						});
      
      						//Get
      						var colSpan = $(".selector").igGrid("option", "columns")[0].colSpan;
      					 
    • columnCssClass

      Type:
      string
      Default:
      null

      Space-separated list of CSS classes to be applied on the data cells of this column. The class is not applied if the column has a column template defined, which contains full <td> definition in the template.

      Code Sample

       
      						<style>
      							.colStyle {
      								background-color: red;
      							}
      						</style>
      
      						$(".selector").igGrid({
      						autoGenerateColumns: false,
      						columns: [
      							{ headerText: "Product ID", key: "ProductID", dataType: "number", columnCssClass: "colStyle" },
      							{ headerText: "Product Name", key: "Name", dataType: "string" },
      							{ headerText: "ProductNumber", key: "ProductNumber", dataType: "string" },
      							{ headerText: "Color", key: "Color", dataType: "string" },
      							{ headerText: "StandardCost", key: "StandardCost", dataType: "number" }
      						]
      						});
      						//Get
      						var colCssClass =  $(".selector").igGrid("option", "columns")[0].columnCssClass;
      					 
    • columnIndex

      Type:
      number
      Default:
      null

      Specifies the column index of the cell in a Multi-Row Layout configuration. All columns must have this property set for the multi-row-layout mode to be enabled. Here you can find more about the Multi-Row Layout feature.

      Code Sample

       
      						//Initialize
      						$(".selector").igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{ headerText: "Product ID", key: "ProductID", dataType: "number", rowIndex: 0, columnIndex: 0 },
      								{ headerText: "Product Name", key: "Name", dataType: "string", rowIndex: 0, columnIndex: 1, colSpan: 3 },
      								{ headerText: "ProductNumber", key: "ProductNumber", dataType: "string", rowIndex: 1, columnIndex: 0 },
      								{ headerText: "Color", key: "Color", dataType: "string", rowIndex: 1, columnIndex: 1 },
      								{ headerText: "StandardCost", key: "StandardCost", dataType: "number", rowIndex: 1, columnIndex: 2, colSpan: 2 },
      							]
      						});
      
      						//Get
      						var colIndex = $(".selector").igGrid("option", "columns")[0].columnIndex;
      					 
    • dataType

      Type:
      enumeration
      Default:
      string

      Data type of the column cell values: string, number, bool, date, object.

      Code Sample

       
      						//Initialize
      						$(".selector").igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{ headerText: "Product ID", key: "ProductID", dataType: "number" },
      								{ headerText: "Product Name", key: "Name", dataType: "string" },
      								{ headerText: "Production Date", key: "ProductionDate", dataType: "date" },
      							]
      						});
      						//Get
      						var cols = $(".selector").igGrid("option", "columns");
      						var productIdDataType = cols[0].dataType;
      					 
    • format

      Type:
      string
      Default:
      null

      Gets/Sets the type of formatting for cells of the column. Default value is null. Checkout Formatting Dates, Numbers and Strings for details on the valid formatting specifiers.

      If dataType is "date", then supported formats are following: "date", "dateLong", "dateTime", "time", "timeLong", "MM/dd/yyyy", "MMM-d, yy, h:mm:ss tt", "dddd d MMM", etc.
      If dataType is "number", then supported numeric formats are following: "number", "currency", "percent", "int", "double", "0.00", "#.0####", "0", "#.#######", etc.
      The value of "double" will be similar to "number", but with unlimited maximum number of decimal places.
      The format patterns and rules for numbers and dates are defined in $.ig.regional.defaults object.
      If dataType is "string" or not set, then format is rendered as it is with replacement of possible "{0}" flag by value in cell. Example, if format is set to "Name: {0}" and value in cell is "Bob", then value will appear as "Name: Bob"
      If value is set to "checkbox", then checkboxes are used regardless of renderCheckboxes option of the grid. That has effect only when dataType option of column is set to "bool".

      Code Sample

       
      						// Initialize
      						$(".selector").igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{ headerText: "Product ID", key: "ProductID", dataType: "number", format: "number" },
      								{ headerText: "Production Date", key: "ProductionDate", dataType: "date", format: "ddd, MMM-d-yy HH:mm" },
      							]
      						});
      
      						// Get
      						var cols = $(".selector").igGrid("option", "columns");
      						var productIdFormat = cols[0].format;
      					 
    • formatter

      Type:
      enumeration
      Default:
      null

      Reference to a function (string or function) which will be used for formatting the cell values. The function should accept a value and return the new formatted value. Here column formatting is explained in details.

      Members

      • string
      • Type:string
      • The name of the function which will be used for formatting the cell values.
      • function
      • Type:function
      • Function which will be used for formatting the cell values. The function should accept a value and return the new formatted value.

      Code Sample

       
      						// Initialize
      						$(".selector").igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{ headerText: "In production", key: "InProduction", formatter: function(val, record) {return (val === 1)? "Yes" : "No";} }
      							]
      						});
      						// Get
      						var cols = $(".selector").igGrid("option", "columns");
      						var inProductionFormatter = cols[0].formatter;
      					 
    • formula

      Type:
      enumeration
      Default:
      null

      A reference to or the name of a JavaScript function, which will calculate the value of the current cell based on other cell values in the same row. Used with unbound columns.

      Members

      • string
      • Type:string
      • The name of the JavaScript function.
      • function
      • Type:function
      • Reference to the JavaScript function.

      Code Sample

       
      						// Initialize
      						$(".selector").igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{ headerText: "Total", key: "TotalUC", unbound: true,  formula: function (data, grid)
      									{
      										return data["UnitPrice"] * data["UnitsInStock"];
      									}
      								}
      							]
      						});
      						// Get
      						var totalUC = $('.selector').igGrid('getUnboundColumnByKey', 'TotalUC');
      						var totalFormula = totalUC.formula;
      					 
    • group

      Type:
      array
      Default:
      []
      Elements Type:
      object

      Array of child column definitions. If the column has the property group than the grid has multi column headers.

      Code Sample

       
      						// Initialize
      						$(".selector").igGrid({
      							columns: [
      								{ headerText: "Product Data", key: "ProductData", group: [
      									{ headerText: "Product Name", key: "Name", dataType: "string" },
      									{ headerText: "Product Number", key: "ProductNumber", dataType: "string" }
      								]}
      							],
      							features:[
      								{
      									name: "MultiColumnHeaders"
      								}
      							],
      							width: "500px"
      						});
      
      						// Get
      						// getMultiColumnHeaders method returns multicolumn headers array. if there aren't multicolumn headers returns undefined.
      						var columns = $(".selector").igGridMultiColumnHeaders("getMultiColumnHeaders");
      						var group = columns[0].group;
      					 
    • groupOptions

      Type:
      object
      Default:
      {}

      Options used to configure collapsible column groups.

      Code Sample

       
                              //Initialize
                              $(".selector").igGrid({
                                  columns: [
                                      {
                                          headerText: "Company Information",
                                          group: [
                                              {
                                                  headerText: "Company Name", key: "CompanyName", dataType: "string", width: "150px",
                                                  groupOptions: {
                                                      hidden: "parentcollapsed"
                                                  }
                                              },
                                              {
                                                  headerText: "Contact Name", key: "ContactName", dataType: "string", width: "150px",
                                                  groupOptions: {
                                                      hidden: "parentcollapsed"
                                                  }
                                              },
                                              { headerText: "Contact Title", key: "ContactTitle", dataType: "string", width: "150px" }
                                          ],
                                          groupOptions: {
                                              expanded: false,
                                              allowGroupCollapsing: true
                                          },
                                          key: "companyInfo"
                                      }
                                  ],
                                  features: [
                                      {
                                          name: "MultiColumnHeaders"
                                      }
                                  ],
                                  width: "500px"
                              });
      
                              //Get
                              var columns = $(".selector").igGridMultiColumnHeaders("getMultiColumnHeaders");
                              var groupOptions = columns[0].groupOptions;
                           
      • allowGroupCollapsing

        Type:
        bool
        Default:
        false

        Sets whether expansion indicators are visible in the group header.

        Code Sample

         
                                    //Initialize
                                    $(".selector").igGrid({
                                        columns: [
                                            {
                                                headerText: "Company Information",
                                                group: [
                                                    {
                                                        headerText: "Company Name", key: "CompanyName", dataType: "string", width: "150px",
                                                        groupOptions: {
                                                            hidden: "parentcollapsed"
                                                        }
                                                    },
                                                    {
                                                        headerText: "Contact Name", key: "ContactName", dataType: "string", width: "150px",
                                                        groupOptions: {
                                                            hidden: "parentcollapsed"
                                                        }
                                                    },
                                                    { headerText: "Contact Title", key: "ContactTitle", dataType: "string", width: "150px" }
                                                ],
                                                groupOptions: {
                                                    expanded: false,
                                                    allowGroupCollapsing: true
                                                },
                                                key: "companyInfo"
                                            }
                                        ],
                                        features: [
                                            {
                                                name: "MultiColumnHeaders"
                                            }
                                        ],
                                        width: "500px"
                                    });
        
                                    //Get
                                    var columns = $(".selector").igGridMultiColumnHeaders("getMultiColumnHeaders");
                                    var groupOptions = columns[0].groupOptions;
                                    var allowGroupCollapsing = groupOptions.allowGroupCollapsing;
                                 
      • expanded

        Type:
        bool
        Default:
        true

        Sets whether the group is expanded or collapsed. Applied only if the allowGroupCollapsing is set to true.

        Code Sample

         
                                    //Initialize
                                    $(".selector").igGrid({
                                        columns: [
                                            {
                                                headerText: "Company Information",
                                                group: [
                                                    {
                                                        headerText: "Company Name", key: "CompanyName", dataType: "string", width: "150px",
                                                        groupOptions: {
                                                            hidden: "parentcollapsed"
                                                        }
                                                    },
                                                    {
                                                        headerText: "Contact Name", key: "ContactName", dataType: "string", width: "150px",
                                                        groupOptions: {
                                                            hidden: "parentcollapsed"
                                                        }
                                                    },
                                                    { headerText: "Contact Title", key: "ContactTitle", dataType: "string", width: "150px" }
                                                ],
                                                groupOptions: {
                                                    expanded: false,
                                                    allowGroupCollapsing: true
                                                },
                                                key: "companyInfo"
                                            }
                                        ],
                                        features: [
                                            {
                                                name: "MultiColumnHeaders"
                                            }
                                        ],
                                        width: "500px"
                                    });
        
                                    //Get
                                    var columns = $(".selector").igGridMultiColumnHeaders("getMultiColumnHeaders");
                                    var groupOptions = columns[0].groupOptions;
                                    var expanded = groupOptions.expanded;
                                 
      • hidden

        Type:
        enumeration
        Default:
        never

        Sets when should the group be hidden. Applied only if the allowGroupCollapsing is set to true.

        Members

        • never
        • Type:string
        • never hide the group.
        • always
        • Type:string
        • always hide the group.
        • parentcollapsed
        • Type:string
        • hide the group when its parent group is collapsed.
        • parentexpanded
        • Type:string
        • hide the group when its parent group is expanded.

        Code Sample

         
                                    //Initialize
                                    $(".selector").igGrid({
                                        columns: [
                                            {
                                                headerText: "Company Information",
                                                group: [
                                                    {
                                                        headerText: "Company Name", key: "CompanyName", dataType: "string", width: "150px",
                                                        groupOptions: {
                                                            hidden: "parentcollapsed"
                                                        }
                                                    },
                                                    {
                                                        headerText: "Contact Name", key: "ContactName", dataType: "string", width: "150px",
                                                        groupOptions: {
                                                            hidden: "parentcollapsed"
                                                        }
                                                    },
                                                    { headerText: "Contact Title", key: "ContactTitle", dataType: "string", width: "150px" }
                                                ],
                                                groupOptions: {
                                                    expanded: false,
                                                    allowGroupCollapsing: true
                                                },
                                                key: "companyInfo"
                                            }
                                        ],
                                        features: [
                                            {
                                                name: "MultiColumnHeaders"
                                            }
                                        ],
                                        width: "500px"
                                    });
                                    //Get
                                    var columns = $(".selector").igGridMultiColumnHeaders("getMultiColumnHeaders");
                                    var groupOptions = columns[0].group[0].groupOptions;
                                    var hidden = groupOptions.hidden;
                                 
    • headerCssClass

      Type:
      string
      Default:
      null

      Space-separated list of CSS classes to be applied on the header cell of this column.

      Code Sample

       
      						<style>
      							.headerCss {
      								background-color: red;
      							}
      						</style>
      
      						// Initialize
      						$(".selector").igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{ headerText: "Product Name", key: "Name", dataType: "string", headerCssClass: "headerCss" }
      							]
      						});
      
      						// Get
      						var headerCss = $(".selector").igGrid("option", "columns");
      						var headerCssClass = cols[0].headerCssClass;
      					 
    • headerText

      Type:
      string
      Default:
      null

      Header text for the specified column.

      Code Sample

       
      						// Initialize
      						$(".selector").igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{ headerText: "Product Name", key: "Name", dataType: "string" },
      							]
      						});
      
      						// Get
      						var cols = $(".selector").igGrid("option", "columns");
      						var productNameHeaderText = cols[0].headerText;
      					 
    • hidden

      Type:
      bool
      Default:
      false

      Initial visibility of the column. A column can be hidden without the Hiding feature being enabled but there will be no UI for unhiding it. Columns can be defined as hidden in the options of the Hiding feature as well and those definitions take precedence.

      Code Sample

       
      						// Initialize
      						$('.selector').igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{ headerText: "Product Name", key: "Name", dataType: "string", hidden: true },
      							]
      						});
      
      						// Get
      						var cols = $('.selector').igGrid('option', 'columns');
      						var productNameHidden = cols[0].hidden;
      					 
    • key

      Type:
      string
      Default:
      null

      The property in the data source to which the column is bound. Also used to identify the column by, and find specific columns with API methods such as columnByKey.

      Code Sample

       
      						// Initialize
      						$(".selector").igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{ headerText: "Product Name", key: "Name", dataType: "string" },
      							]
      						});
      
      						// Get
      						var cols = $(".selector").igGrid("option", "columns");
      						var productNameKey = cols[0].key;
      					 
    • mapper

      Type:
      enumeration
      Default:
      null

      This option is applicable only for columns with dataType of object. Reference to a function, or the name of the function, that will be used for complex data extraction from the data records, whose return value will be used for all data operations associated with this column and will be displayed as cell value. Here you can find more examples of how to setup a column mapper.

      Members

      • string
      • Type:string
      • The name of the mapper function.
      • function
      • Type:function
      • Reference to the mapper function.

      Code Sample

       
      						//Initialize
      						$(".selector").igGrid({
      							columns: [
      								{ headerText: "Product ID", key: "ProductID", dataType: "number" },
      								{ headerText: "Product Name", key: "Name", dataType: "string" },
      								{ headerText: "Product Number", key: "ProductNumber", dataType: "string" },
      								{
      									headerText: "Category",
      									key: "Category",
      									dataType: "object",
      									mapper: function (record) {
      										return record.Category.Name;
      									}
      								}
      							]
      						});
      						//Get
      						var cols = $(".selector").igGrid("option", "columns");
      						var categoryMapper = cols[3].mapper;
      					 
    • navigationIndex

      Type:
      number
      Default:
      null

      Specifies the navigation index of the cell for the TAB sequence when the cells are in edit mode in a Multi-Row Layout grid. Has no effect otherwise. Here you can find more about the Multi-Row Layout feature.

      Code Sample

       
      					//Initialize
      					$(".selector").igGrid({
      						autoGenerateColumns: false,
      						columns: [
      							{ headerText: "Product ID", key: "ProductID", dataType: "number", rowIndex: 0, columnIndex: 0 },
      							{ headerText: "Product Name", key: "Name", dataType: "string", rowIndex: 0, columnIndex: 1, colSpan: 3, navigationIndex: 1 },
      							{ headerText: "ProductNumber", key: "ProductNumber", dataType: "string", rowIndex: 1, columnIndex: 0, navigationIndex: 2 },
      							{ headerText: "Color", key: "Color", dataType: "string", rowIndex: 1, columnIndex: 1, navigationIndex: 4 },
      							{ headerText: "StandardCost", key: "StandardCost", dataType: "number", rowIndex: 1, columnIndex: 2, colSpan: 2, navigationIndex: 3 }
      						]
      					});
      					//Get
      					var colIndex = $(".selector").igGrid("option", "columns")[1].navigationIndex;
      					 
    • rowIndex

      Type:
      number
      Default:
      null

      Specifies the row index of the cell in a Multi-Row Layout configuration. All columns must have this property set for the multi-row-layout mode to be enabled. Here you can find more about the Multi-Row Layout feature.

      Code Sample

       
      						//Initialize
      						$(".selector").igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{ headerText: "Product ID", key: "ProductID", dataType: "number", rowIndex: 0, columnIndex: 0 },
      								{ headerText: "Product Name", key: "Name", dataType: "string", rowIndex: 0, columnIndex: 1, colSpan: 3 },
      								{ headerText: "ProductNumber", key: "ProductNumber", dataType: "string", rowIndex: 1, columnIndex: 0 },
      								{ headerText: "Color", key: "Color", dataType: "string", rowIndex: 1, columnIndex: 1 },
      								{ headerText: "StandardCost", key: "StandardCost", dataType: "number", rowIndex: 1, columnIndex: 2, colSpan: 2 },
      							]
      						});
      
      						//Get
      						var rowIndex = $(".selector").igGrid("option", "columns")[0].rowIndex;
      					 
    • rowspan
      Deprecated

      Type:
      number
      Default:
      0

      This option has been deprecated as of the June 2016 service release.
      Adjust span of multi column header cell. Use option rowSpan.

    • rowSpan

      Type:
      number
      Default:
      1

      Specifies the rowSpan of the cell in a Multi-Row Layout configuration. rowSpan 0 is not supported and will be changed to 1 by the grid. Here you can find more about the Multi-Row Layout feature. If multi-row-layout is not used but multi-column-header is set then this option is used to adjust span of header cell.

      Code Sample

       
      						//Initialize
      						$(".selector").igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{ headerText: "Product ID", key: "ProductID", dataType: "number", rowIndex: 0, columnIndex: 0, rowSpan: 2 },
      								{ headerText: "Product Name", key: "Name", dataType: "string", rowIndex: 0, columnIndex: 1, colSpan: 3 },
      								{ headerText: "ProductNumber", key: "ProductNumber", dataType: "string", rowIndex: 1, columnIndex: 1 },
      								{ headerText: "Color", key: "Color", dataType: "string", rowIndex: 1, columnIndex: 2 },
      								{ headerText: "StandardCost", key: "StandardCost", dataType: "number", rowIndex: 1, columnIndex: 3 },
      							]
      						});
      
      						//Get
      						var rowSpan = $(".selector").igGrid("option", "columns")[0].rowSpan;
      					 
    • template

      Type:
      string
      Default:
      null

      Sets a template for an individual column. the contents of the template should be the HTML markup that goes inside the table cell, or the entire table cell markup. Here's an example of creating a basic column template.

      Code Sample

       
      						// Initialize
      						$(".selector").igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{ headerText: "Product Name", key: "Name", dataType: "string", template: "Product: ${Name}" },
      							]
      						});
      
      						// Get
      						var cols = $(".selector").igGrid("option", "columns");
      						var template = cols[0].template;
      					 
    • unbound

      Type:
      bool
      Default:
      false

      Sets whether column data is derived from the datasource. If set to true, then the cells in this column are not bound to the data source. The data in this column is populated using formula, or using unboundValues, or through the setUnboundValues API method. Here's an overview of the unbound columns feature.

      Code Sample

       
      						// Initialize
      						$(".selector").igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{
      									headerText: "Promotion Expired Date",
      									key: "PromExpDate",
      									dataType: "date",
      									unbound: true,
      									unboundValues: [
      										new Date('4/24/2016'),
      										new Date('8/24/2016'),
      										new Date('6/24/2016'),
      										new Date('10/24/2016'),
      										new Date('11/24/2016')
      									]
      								}
      							]
      						});
      
      						// Get
      						var unboundColumn = $(".selector").igGrid('getUnboundColumnByKey', 'PromExpDate');
      						var isUnbound = unboundColumn.unbound;
      					 
    • unboundValues

      Type:
      array
      Default:
      null
      Elements Type:

      Array of values which will be populated in the column cells at initialization, if the column is unbound.

      Code Sample

       
      						// Initialize
      						$(".selector").igGrid({
      							autoGenerateColumns: false,
      							columns: [
      								{
      									headerText: "Promotion Expired Date",
      									key: "PromotionExpDate",
      									dataType: "date",
      									unbound: true,
      									unboundValues: [
      										new Date('4/24/2016'),
      										new Date('8/24/2016'),
      										new Date('6/24/2016'),
      										new Date('10/24/2016'),
      										new Date('11/24/2016')
      									]
      								}
      							]
      						});
      					 
    • width

      Type:
      enumeration
      Default:
      null

      Width of the column in pixels or percentage. Can also be set as '*', in which case the width auto-size based on the content of the column cells (including the header text). If width is not defined and defaultColumnWidth is set, it is assumed for all columns.

      Members

      • string
      • Type:string
      • The column width can be set in pixels (px), percentage (%) or as '*' in order to auto-size based on the cells and header content.
      • number
      • Type:number
      • The column width can be set as a number.

      Code Sample

       
      							// Initialize
      							$(".selector").igGrid({
      								autoGenerateColumns: false,
      								columns: [
      									{ headerText: "Product Name", key: "Name", width: "100px", dataType: "string" },
      								]
      							});
      							// Get
      							var cols = $(".selector").igGrid("option", "columns");
      							var productNameWidth = cols[0].width;
      						 
  • columnVirtualization

    Type:
    bool
    Default:
    false

    Enables virtualization for columns only. Column virtualization can work only in combination with fixed row virtalization. Setting columnVirtualization to true will automatically set virtualization to true and virtualizationMode to "fixed".

    Code Sample

     
    				// Initialize
    				$(".selector").igGrid({
    					columnVirtualization : true
    				});
    
    				// Get
    				var columnVirtualization = $(".selector").igGrid("option", "columnVirtualization");
    			 
  • dataSource

    Type:
    object
    Default:
    null

    Can be any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					dataSource : ds
    				});
    
    				//Get
    				var ds = $(".selector").igGrid("option", "dataSource");
    
    				Note:
    				This code will return the original data source used when initializing the grid.
    				To get the igDataSource instance use the following syntax:
    				var igDs = $(".selector").data("igGrid").dataSource;
    
    				//Set
    				$(".selector").igGrid("option", "dataSource", ds);
    			 
  • dataSourceType

    Type:
    string
    Default:
    null

    Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource type.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					dataSourceType : "xml"
    				});
    
    				//Get
    				var dsType = $(".selector").igGrid("option", "dataSourceType");
    			 
  • dataSourceUrl

    Type:
    string
    Default:
    null

    Specifies a remote URL as a data source, from which data will be retrieved using the $.ig.DataSource.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					dataSourceUrl : urlString
    				});
    
    				//Get
    				var urlString = $(".selector").igGrid("option", "dataSourceUrl");
    			 
  • defaultColumnWidth

    Type:
    enumeration
    Default:
    null

    Default column width that will be set for all columns, that don't have column width defined.

    Members

    • string
    • Type:string
    • The default column width can be set in pixels ("100px").
    • number
    • Type:number
    • The default column width can be set in pixels as a number (100).

    Code Sample

     
    				// Initialize
    				$(".selector").igGrid({
    					defaultColumnWidth : 100
    				});
    				// Get
    				var width = $(".selector").igGrid("option", "defaultColumnWidth");
    			 
  • enableHoverStyles

    Type:
    bool
    Default:
    true

    Enables/disables rendering of hover styles when the mouse is over a record. This can be useful in templating scenarios, for example, where we don't want to apply hover styling to templated content.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					enableHoverStyles : false
    				});
    
    				//Get
    				var enableHoverStyles = $(".selector").igGrid("option", "enableHoverStyles");
    			 
  • enableResizeContainerCheck

    Type:
    bool
    Default:
    true

    Enables/disables grid adjusting its dimensions when its width and/or height is set in percent (%) and grid parent DOM container is resized.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					enableResizeContainerCheck : false
    				});
    
    				//Get
    				var enableResizeContainerCheck = $(".selector").igGrid("option", "enableResizeContainerCheck");
    
    				//Set
    				$(".selector").igGrid("option", "enableResizeContainerCheck", false);
    			 
  • enableUTCDates

    Type:
    bool
    Default:
    false

    Enables formatting of the dates as UTC dates. Note that this may be desirable when the dates are coming from a backend, encoded as UTC. Otherwise, if dates are created on the client (in the browser), most probably keeping enableUTCDates to false is the desired behavior.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					enableUTCDates : true
    				});
    
    				//Get
    				var enableHoverStyles = $(".selector").igGrid("option", "enableUTCDates");
    			 
  • featureChooserIconDisplay

    Type:
    enumeration
    Default:
    desktopOnly

    Configures how the feature chooser icon should display on header cells - e.g. to display as gear icon or not.

    Members

    • none
    • Type:string
    • Always hide the feature chooser icon; The feature chooser is shown on tapping/clicking the column header.
    • desktopOnly
    • Type:string
    • Always show the icon on desktop but hide when touch device detected.
    • always
    • Type:string
    • Always show it in any environment. Chooser is shown when tapping the gear icon or column header.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					featureChooserIconDisplay : "always"
    				});
    				//Get
    				var featureChooserIconDisplay = $(".selector").igGrid("option", "featureChooserIconDisplay");
    			 
  • features

    Type:
    array
    Default:
    []
    Elements Type:
    object

    List of grid feature definitions: sorting, paging, etc. Each feature goes with its separate options that are documented for the feature accordingly. Here you can find detailed documentation for all igGrid features.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    			features: [
    				{
    							name: "Paging",
    							type: "local",
    							pageSize: 13
    						},
    						{
    							name: "Sorting",
    							type: "local"
    						},
    						{
    							name: "Selection"
    						},
    						{
    							name: "Filtering",
    							type: "local",
    							filterDropDownItemIcons: false,
    							filterDropDownWidth: 200
    						}
    					]
    				});
    
    				//Get
    				var features = $(".selector").igGrid("option", "features");
    			 
    • name

      Type:
      string
      Default:
      null

      Name of the feature to be enabled.

  • fixedFooters

    Type:
    bool
    Default:
    true

    Footers will be fixed if this option is set to true, and only the grid data will be scrollable. If virtualization is enabled, fixedFooters will always act as if it's true, no matter which value is set.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					fixedFooters : false
    				});
    
    				//Get
    				var fixed = $(".selector").igGrid("option", "fixedFooters");
    
    				//Set
    				$(".selector").igGrid("option", "fixedFooters", false);
    			 
  • fixedHeaders

    Type:
    bool
    Default:
    true

    Headers will be fixed if this option is set to true, and only the grid data will be scrollable. If virtualization is enabled, fixedHeaders will always act as if it's true, no matter which value is set.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					fixedHeaders : false
    				});
    
    				//Get
    				var fixedHeaders = $(".selector").igGrid("option", "fixedHeaders");
    			 
  • height

    Type:
    enumeration
    Default:
    null

    This is the total height of the grid, including all UI elements - scroll container with data rows, header, footer, filter row - (if any), etc. Here you can find more info about setting igGrid height.

    Members

    • string
    • Type:string
    • The widget height can be set in pixels (px) and percentage (%).
    • number
    • Type:number
    • The widget height can be set as a number.
    • null
    • Type:object
    • will stretch vertically to fit data.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					height : "850px"
    				});
    				// Get
    				var height = $(".selector").igGrid("option", "height");
    				// Set
    				$(".selector").igGrid("option", "height", "800px");
    			 
  • jsonpRequest

    Type:
    bool
    Default:
    false

    When dataSource is a remote URL, defines whether to set the type of the remote data source to JSONP.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					jsonpRequest : true
    				});
    
    				//Get
    				var jsonpRequest = $(".selector").igGrid("option", "jsonpRequest");
    			 
  • localSchemaTransform

    Type:
    bool
    Default:
    true

    If this option is set to false, the data to which the grid is bound will be used "as is" with no additional transformations based on columns defined. Otherwise only the subset of data properties used in the columns defined will be extracted in a new object and used.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					localSchemaTransform : false
    				});
    
    				//Get
    				var schemaTransform = $(".selector").igGrid("option", "localSchemaTransform");
    			 
  • mergeUnboundColumns

    Type:
    bool
    Default:
    false

    Merge unbound columns values inside data source when data source is remote. If true then the unbound columns are merged to the data source at runtime on the server. Note that data source is expanded with the new data and this could cause performance issues when the data is huge. If mergeUnboundColumns is false then the unbound data is sent and merged on the client. This option is used by the igGrid MVC Helper.
    Checkout Populating Unbound Columns Remotely (igGrid) topic for more information.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					mergeUnboundColumns : true,
    					dataSource : REMOTE_URL
    				});
    
    				//Get
    				var mergeUC = $(".selector").igGrid("option", "mergeUnboundColumns");
    			 
  • primaryKey

    Type:
    string
    Default:
    null

    Key of the column containing unique identifiers for the data records.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					primaryKey : "CustomerID"
    				});
    
    				//Get
    				var key = $(".selector").igGrid("option", "primaryKey");
    			 
  • renderCheckboxes

    Type:
    bool
    Default:
    false

    Gets sets ability to render checkboxes and use checkbox editor when dataType of a column is "bool". Checkboxes are not rendered for boolean values in columns with a column template.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					renderCheckboxes : true
    				});
    
    				//Get
    				var renderCheckboxes = $(".selector").igGrid("option", "renderCheckboxes");
    
    				//Set
    				$(".selector").igGrid("option", "renderCheckboxes", true);
    			 
  • requestType

    Type:
    string
    Default:
    "GET"

    Specifies the HTTP verb to be used to issue the requests to a remote data source.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					requestType : "POST"
    				});
    
    				//Get
    				var requestType = $(".selector").igGrid("option", "requestType");
    			 
  • requiresDataBinding

    Type:
    bool
    Default:
    true

    *** IMPORTANT *** This is an internal option and should not be used.

  • responseContentType

    Type:
    string
    Default:
    "application/json; charset=utf-8"

    Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					responseContentType : "application/json; charset=utf-8"
    				});
    
    				//Get
    				var responseContentType = $(".selector").igGrid("option", "responseContentType");
    			 
  • responseDataKey

    Type:
    string
    Default:
    null

    See $.ig.DataSource responseDataKey. This is the property in the responses where data records are held, if the response is wrapped.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					responseDataKey : "records"
    				});
    
    				//Get
    				var responseKey = $(".selector").igGrid("option", "responseDataKey");
    			 
  • responseTotalRecCountKey

    Type:
    string
    Default:
    null

    See $.ig.DataSource responseTotalRecCountKey. Property in the response specifying the total number of records on the server.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					responseTotalRecCountKey : "totalRecords"
    				});
    
    				//Get
    				var recordsCount = $(".selector").igGrid("option", "responseTotalRecCountKey");
    			 
  • restSettings

    Type:
    object
    Default:
    {}

    Settings related to REST compliant update routines.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					restSettings : {
    						create: {
    							url: "/api/customers/",
    							batch: true
    						},
    						update: {
    							url: "/api/customers/",
    							batch: true
    						}
    						remove: {
    							url: "/api/customers/",
    							batch: true
    						}
    					}
    				});
    
    				//Get
    				var restSettings = $(".selector").igGrid("option", "restSettings");
    			 
    • contentSerializer

      Type:
      function
      Default:
      null

      Specifies a custom function to serialize content sent to the server. It should accept a single object or an array of objects and return a string. If not specified, JSON.stringify() will be used.

      Code Sample

       
      					//Initialize
      					$(".selector").igGrid({
      						restSettings : {
      							contentSerializer : "customSerializeFunction" ; // the name of the function, it can be also a reference to a function
      						}
      					});
      
      					//Get
      					var restSettings = $(".selector").igGrid("option", "restSettings");
      					var contentSerializerSetting = restSettings.contentSerializer;
      				 
    • contentType

      Type:
      string
      Default:
      "application/json; charset=utf-8"

      Specifies the content type of the request. See http://api.jquery.com/jQuery.ajax/ => contentType.

      Code Sample

       
      						//Initialize
      						$(".selector").igGrid({
      							restSettings : {
      								contentType : "application/json; charset=utf-8";
      							}
      						});
      
      						//Get
      						var restSettings = $(".selector").igGrid("option", "restSettings");
      						var contentTypeSetting = restSettings.contentType;
      				 
    • create

      Type:
      object
      Default:
      {}

      Settings for create requests.

      Code Sample

       
      					//Initialize
      					$(".selector").igGrid({
      						restSettings : {
      				create: {
      								url: "/api/customers/",
      								batch: true
      							}
      						}
      					});
      
      					//Get
      					var restSettings = $(".selector").igGrid("option", "restSettings");
      					var createRestSettings = restSettings.create;
      				 
      • batch

        Type:
        bool
        Default:
        false

        Specifies whether create requests will be sent in batches.

        Code Sample

         
        						//Initialize
        						$(".selector").igGrid({
        							restSettings : {
        								create: {
        									url: "/api/customers/",
        									batch: true
        								}
        							}
        						});
        
        						//Get
        						var restSettings = $(".selector").igGrid("option", "restSettings");
        						var batch = restSettings.create.batch;
        					 
      • template

        Type:
        string
        Default:
        null

        Specifies a remote URL template. Use ${id} in place of the resource id.

        Code Sample

         
        						//Initialize
        						$(".selector").igGrid({
        							restSettings : {
        								update: {
        									template: "/api/customers/${id}"
        								}
        							}
        						});
        
        						//Get
        						var restSettings = $(".selector").igGrid("option", "restSettings");
        						var template = restSettings.update.template;
        					 
      • url

        Type:
        string
        Default:
        null

        Specifies a remote URL to which create requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests.

        Code Sample

         
        						//Initialize
        						$(".selector").igGrid({
        							restSettings : {
        								update: {
        									url: "/api/customers/",
        									batch: true
        								}
        							}
        						});
        
        						//Get
        						var restSettings = $(".selector").igGrid("option", "restSettings");
        						var url = restSettings.update.url;
        					 
    • encodeRemoveInRequestUri

      Type:
      bool
      Default:
      true

      Specifies whether the ids of the removed resources are send through the request URI.

      Code Sample

       
              //Initialize
              $(".selector").igGrid({
                  restSettings : {
                      encodeRemoveInRequestUri: true
                  }
              });
      
              //Get
              var restSettings = $(".selector").igGrid("option", "restSettings");
              var encodeRemoveInRequestUri = restSettings.encodeRemoveInRequestUri;
                
    • remove

      Type:
      object
      Default:
      {}

      Settings for remove requests.

      Code Sample

       
              //Initialize
              $(".selector").igGrid({
                  restSettings : {
                      remove: {
                          url: "/api/customers/",
                          batch: true
                      }
                  }
              });
      
              //Get
              var restSettings = $(".selector").igGrid("option", "restSettings");
              var removeRestSettings = restSettings.remove;
                
      • batch

        Type:
        bool
        Default:
        false

        Specifies whether update requests will be sent in batches.

        Code Sample

         
                //Initialize
                $(".selector").igGrid({
                    restSettings : {
                        remove: {
                            url: "/api/customers/",
                            batch: true
                        }
                    }
                });
        
                //Get
                var restSettings = $(".selector").igGrid("option", "restSettings");
                var batch = restSettings.remove.batch;
                      
      • template

        Type:
        string
        Default:
        null

        Specifies a remote URL template. Use ${id} in place of the resource id.

        Code Sample

         
                //Initialize
                $(".selector").igGrid({
                    restSettings : {
                        remove: {
                            template: "/api/customers/${id}"
                        }
                    }
                });
        
                //Get
                var restSettings = $(".selector").igGrid("option", "restSettings");
                var template = restSettings.remove.template;
                      
      • url

        Type:
        string
        Default:
        null

        Specifies a remote URL to which remove requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests.

        Code Sample

         
                //Initialize
                $(".selector").igGrid({
                    restSettings : {
                        remove: {
                            url: "/api/customers/",
                            batch: true
                        }
                    }
                });
        
                //Get
                var restSettings = $(".selector").igGrid("option", "restSettings");
                var url = restSettings.remove.url;
                      
    • update

      Type:
      object
      Default:
      {}

      Settings for update requests.

      Code Sample

       
              //Initialize
              $(".selector").igGrid({
                  restSettings : {
                      update: {
                          url: "/api/customers/",
                          batch: true
                      }
                  }
              });
      
              //Get
              var restSettings = $(".selector").igGrid("option", "restSettings");
              var updateRestSettings = restSettings.update;
                
      • batch

        Type:
        bool
        Default:
        false

        Specifies whether update requests will be sent in batches.

        Code Sample

         
                //Initialize
                $(".selector").igGrid({
                    restSettings : {
                        update: {
                            url: "/api/customers/",
                            batch: true
                        }
                    }
                });
        
                //Get
                var restSettings = $(".selector").igGrid("option", "restSettings");
                var batch = restSettings.update.batch;
                      
      • template

        Type:
        string
        Default:
        null

        Specifies a remote URL template. Use ${id} in place of the resource id.

        Code Sample

         
                //Initialize
                $(".selector").igGrid({
                    restSettings : {
                        update: {
                            template: "/api/customers/${id}"
                        }
                    }
                });
        
                //Get
                var restSettings = $(".selector").igGrid("option", "restSettings");
                var template = restSettings.update.template;
                      
      • url

        Type:
        string
        Default:
        null

        Specifies a remote URL to which update requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests.

        Code Sample

         
                //Initialize
                $(".selector").igGrid({
                    restSettings : {
                        update: {
                            url: "/api/customers/",
                            batch: true
                        }
                    }
                });
        
                //Get
                var restSettings = $(".selector").igGrid("option", "restSettings");
                var url = restSettings.update.url;
                      
  • rowVirtualization

    Type:
    bool
    Default:
    false

    Enables virtualization for rows only. Here you can find more info about igGrid row virtualization.

    Code Sample

     
    				// Initialize
    				$(".selector").igGrid({
    					rowVirtualization : true
    				});
    
    				// Get
    				var virtualization = $(".selector").igGrid("option", "rowVirtualization");
    			 
  • scrollSettings

    Type:
    object
    Default:
    {}

    Settings related to content scrolling.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					scrollSettings: {
    						scrollTop: 100,
    						smoothing: true,
    						smoothingStep: 2.5
    					}
    				});
    
    				//Get
    				var scrollSettings = $(".selector").igGrid("option", "scrollSettings");
    
    				//Set
    				var newSettings = {
    					scrollTop: 100,
    					smoothing: true,
    					smoothingStep: 2.5
    				}
    				$(".selector").igGrid("option", "scrollSettings", newSettings);
    			 
    • inertiaDuration

      Type:
      number
      Default:
      1

      Sets gets the modifier for how long the inertia last on touch devices.

      Code Sample

       
      					//Initialize
      					$(".selector").igGrid({
      						scrollSettings: {
      							inertiaDuration: 0.75
      						}
      					});
      
      					//Get
      					var value = $(".selector").igGrid("option", "scrollSettings").inertiaDuration;
      
      					//Set
      					$(".selector").igGrid("option", "scrollSettings", { inertiaDuration: 0.75 });
      				 
    • inertiaStep

      Type:
      number
      Default:
      1

      Sets gets the modifier for how much the inertia scrolls on touch devices. Note: Value set to 0 would disable touch movements. Value set to -1 would invert them.

      Code Sample

       
      					//Initialize
      					$(".selector").igGrid({
      						scrollSettings: {
      							inertiaStep: 2
      						}
      					});
      
      					//Get
      					var value = $(".selector").igGrid("option", "scrollSettings").inertiaStep;
      
      					//Set
      					$(".selector").igGrid("option", "scrollSettings", { inertiaStep: 2 });
      				 
    • scrollLeft

      Type:
      number
      Default:
      0

      Sets gets current horizontal position.

      Code Sample

       
      					//Initialize
      					$(".selector").igGrid({
      						scrollSettings: {
      							scrollLeft: 200
      						}
      					});
      
      					//Get
      					var value = $(".selector").igGrid("option", "scrollSettings").scrollLeft;
      
      					//Set
      					$(".selector").igGrid("option", "scrollSettings", { scrollLeft: 300 });
      				 
    • scrollTop

      Type:
      number
      Default:
      0

      Sets gets current vertical position.

      Code Sample

       
      					//Initialize
      					$(".selector").igGrid({
      						scrollSettings: {
      							scrollTop: 500
      						}
      					});
      
      					//Get
      					var value = $(".selector").igGrid("option", "scrollSettings").scrollTop;
      
      					//Set
      					$(".selector").igGrid("option", "scrollSettings", { scrollTop: 600 });
      				 
    • smoothing

      Type:
      bool
      Default:
      false

      Sets gets if smoother scrolling with small intertia should be used when using the mouse wheel.

      Code Sample

       
      					//Initialize
      					$(".selector").igGrid({
      						scrollSettings: {
      							smoothing: true
      						}
      					});
      
      					//Get
      					var value = $(".selector").igGrid("option", "scrollSettings").smoothing;
      
      					//Set
      					$(".selector").igGrid("option", "scrollSettings", { smoothing: true });
      				 
    • smoothingDuration

      Type:
      number
      Default:
      1

      Sets or gets the modifier for how long the scroll ‘animation’ lasts when using the mouse wheel once. This is used only for the smooth scrolling behavior.

      Code Sample

       
      					//Initialize
      					$(".selector").igGrid({
      						scrollSettings: {
      							smoothingDuration: 1.25
      						}
      					});
      
      					//Get
      					var value = $(".selector").igGrid("option", "scrollSettings").smoothingDuration;
      
      					//Set
      					$(".selector").igGrid("option", "scrollSettings", { smoothingDuration: 1.25 });
      				 
    • smoothingStep

      Type:
      number
      Default:
      1

      Sets or gets the modifier for how many pixels will be scrolled when using the mouse wheel once. This is used only for the smooth scrolling behavior.

      Code Sample

       
      					//Initialize
      					$(".selector").igGrid({
      						scrollSettings: {
      							smoothingStep: 2.5
      						}
      					});
      
      					//Get
      					var value = $(".selector").igGrid("option", "scrollSettings").smoothingStep;
      
      					//Set
      					$(".selector").igGrid("option", "scrollSettings", { smoothingStep: 2.5 });
      				 
    • wheelStep

      Type:
      number
      Default:
      50

      Sets gets the step of the default scrolling behavior when using the mouse wheel.

      Code Sample

       
      					//Initialize
      					$(".selector").igGrid({
      						scrollSettings: {
      							wheelStep: 100
      						}
      					});
      
      					//Get
      					var value = $(".selector").igGrid("option", "scrollSettings").wheelStep;
      
      					//Set
      					$(".selector").igGrid("option", "scrollSettings", { wheelStep: 50 });
      				 
  • serializeTransactionLog

    Type:
    bool
    Default:
    true

    If true, the transaction log will always be sent in the request for remote data, by the data source. Also this means that if there are values in the log, a POST will be performed instead of GET.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					serializeTransactionLog : false
    				});
    
    				//Get
    				var log = $(".selector").igGrid("option", "serializeTransactionLog");
    			 
  • showFooter

    Type:
    bool
    Default:
    true

    Controls the visibility of the grid footer.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					showFooter : false
    				});
    
    				//Get
    				var showFooter = $(".selector").igGrid("option", "showFooter");
    
    				//Set
    				$(".selector").igGrid("option", "showFooter", false);
    			 
  • showHeader

    Type:
    bool
    Default:
    true

    Controls the visibility of the grid header.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					showHeader : false
    				});
    
    				//Get
    				var showHeader = $(".selector").igGrid("option", "showHeader");
    
    				//Set
    				$(".selector").igGrid("option", "showHeader", false);
    			 
  • tabIndex

    Type:
    number
    Default:
    0

    Initial tabIndex attribute that will be set on all focusable elements.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					tabIndex : 3
    				});
    
    				//Get
    				var tabIndex = $(".selector").igGrid("option", "tabIndex");
    			 
  • templatingEngine

    Type:
    enumeration
    Default:
    infragistics

    The templating engine that will be used to render the grid column templates. Here you can find how to use templating engines other than igTemplating and jsRender.

    Members

    • infragistics
    • Type:string
    • The grid will use the Infragistics Templating engine to render its column templates and specific parts of the UI.
    • jsRender
    • Type:string
    • The grid will use jsRender to render its column templates and specific parts of the UI.

    Code Sample

     
    				// Initialize
    				$(".selector").igGrid({
    					templatingEngine : "jsRender"
    				});
    				// Get
    				var templatingEngine = $(".selector").igGrid("option", "templatingEngine");
    			 
  • updateUrl

    Type:
    string
    Default:
    null

    URL to which updating requests will be made.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					updateUrl : "http://mydomain.com/UpdateCustomer"
    				});
    
    				//Get
    				var updateUrl = $(".selector").igGrid("option", "updateUrl");
    			 
  • virtualization

    Type:
    bool
    Default:
    false

    Enables/disables column and row virtualization at the same time. Virtualization can greatly enhance rendering performance. If enabled, the number of actual rendered rows (DOM elements) will be constant and related to the visible viewport of the grid. As the end user scrolls, those DOM elements will be dynamically reused to render the new data. Here you can find more info about the performance guidelines when using the igGrid.

    Code Sample

     
    				// Initialize
    				$(".selector").igGrid({
    					virtualization : true
    				});
    
    				// Get
    				var virtualization = $(".selector").igGrid("option", "virtualization");
    			 
  • virtualizationMode

    Type:
    enumeration
    Default:
    fixed

    Determines row virtualization mode.

    Members

    • fixed
    • Type:string
    • Renders only the visible rows and/or columns in the grid. On scrolling the same rows and/or columns are updated with new data from the data source. Only fixed virtualization can work with column virtualization at the same time. Fixed virtualization is not supported by some grid features: Resizing, Group By, Responsive.
    • continuous
    • Type:string
    • renders a pre-defined number of rows in the grid. On scrolling the continuous virtualization loads another portion of rows and disposes the current one.

    Code Sample

     
    				// Initialize
    				$(".selector").igGrid({
    					virtualizationMode : "continuous"
    				});
    				// Get
    				var virtualizationMode = $(".selector").igGrid("option", "virtualizationMode");
    				// Set
    				$(".selector").igGrid("option", "virtualizationMode", "continuous");
    			 
  • virtualizationMouseWheelStep

    Type:
    number
    Default:
    null

    Number of pixels to scroll the grid by, when virtualization is enabled, and mouse wheel scrolling is performed over the virtual grid area. If "null" the step will be equal to the avgRowHeight.

    Code Sample

     
    				// Initialize
    				$(".selector").igGrid({
    					virtualizationMouseWheelStep : 50
    				});
    
    				// Get
    				var virtualizationStep = $(".selector").igGrid("option", "virtualizationMouseWheelStep");
    
    				// Set
    				$(".selector").igGrid("option", "virtualizationMouseWheelStep", 50);
    			 
  • width

    Type:
    enumeration
    Default:
    null

    Defines the grid width in pixels or percents. Here you can find more info about setting igGrid width.

    Members

    • string
    • Type:string
    • The widget width can be set in pixels (px) or percentage (%). Example values: "800px", "800" (defaults to pixels), "100%".
    • number
    • Type:number
    • The widget width can be set in pixels as a number. Example values: 800, 700.
    • null
    • Type:object
    • will stretch to fit the sum of the columns widths.

    Code Sample

     
    				// Initialize
    				$(".selector").igGrid({
    					width : "800px"
    				});
    				// Get
    				var width = $(".selector").igGrid("option", "width");
    				// Set
    				$(".selector").igGrid("option", "width", "850px");
    			 

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
  • cellClick

    Cancellable:
    false

    Event fired when a cell is clicked.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • cellElement

          Gets a reference to cell DOM element.

        • rowIndex
          Type:Number

          Gets the row index.

        • rowKey
          Type:Object

          Gets the row key.

        • colIndex
          Type:Number

          Gets the column index of the DOM element.

        • colKey
          Type:String

          Gets the column key.

        • owner
          Type:Object

          Gets a reference to the grid.

    Code Sample

     
    				//Delegate
    				$(document).delegate(".selector", "iggridcellclick", function (evt, ui) {
    					//return cell html element in the DOM
    					ui.cellElement;
    					//return row index
    					ui.rowIndex;
    					//return row key
    					ui.rowKey;
    					//return col index of the DOM element
    					ui.colIndex;
    					//return col key
    					ui.colKey;
    					//return reference to igGrid
    					ui.owner;
    				});
    
    				//Initialize
    				$(".selector").igGrid({
    					cellClick: function(evt, ui) {...}
    				});
    			 
  • cellRightClick

    Cancellable:
    false

    Event fired when a cell is right clicked.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • cellElement

          Gets a reference to cell DOM element.

        • rowIndex
          Type:Number

          Gets the row index.

        • rowKey
          Type:Object

          Gets the row key.

        • colIndex
          Type:Number

          Gets the column index of the DOM element.

        • colKey
          Type:String

          Gets the column key.

        • row

          Gets a reference to the row DOM element.

        • owner
          Type:Object

          Gets a reference to the grid.

    Code Sample

     
    				$(document).delegate(".selector", "iggridcellrightclick", function (evt, ui) {
    				//return cell html element in the DOM
    				ui.cellElement;
    				//return row index
    				ui.rowIndex;
    				//return row key
    				ui.rowKey;
    				//return col index of the DOM element
    				ui.colIndex;
    				//return col key
    				ui.colKey;
    				//return reference to igGrid
    				ui.owner;
    				});
    
    				//Initialize
    				$(".selector").igGrid({
    					cellRightClick: function(evt, ui) {...}
    				});
    			 
  • columnsCollectionModified

    Cancellable:
    false

    Event fired after the columns colection has been modified(e.g. a column is hidden).

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

    Code Sample

     
    				//Delegate
    				$(document).delegate(".selector", "iggridcolumnscollectionmodified", function (evt, ui) {
    					//return reference to igGrid
    					ui.owner;
    				});
    
    				//Initialize
    				$(".selector").igGrid({
    					columnsCollectionModified: function(evt, ui) {...}
    				});
    			 
  • created

    Cancellable:
    false

    Fired when the grid is created and the initial structure is rendered (this doesn't necessarily imply the data will be there if the data source is remote).

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

    Code Sample

     
    				//Delegate before the igGrid initialization code
    				$(document).delegate(".selector", "igcontrolcreated", function (evt, ui) {
    					//return reference to igGrid
    					ui.owner;
    				});
    			 
  • dataBinding

    Cancellable:
    true

    Event fired before data binding takes place.

    Return false in order to cancel data binding.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

        • dataSource
          Type:Object

          Gets a reference to the igDataSource object.

    Code Sample

     
    				//Delegate
    				$(document).delegate(".selector", "iggriddatabinding", function (evt, ui) {
    					//return reference to igGrid
    					ui.owner;
    				});
    
    				//Initialize
    				$(".selector").igGrid({
    					dataBinding: function(evt, ui) {...}
    				});
    			 
  • dataBound

    Cancellable:
    false

    Event fired after data binding is complete.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

        • dataSource
          Type:Object

          Gets a reference to the igDataSource object.

    Code Sample

     
    				//Delegate
    				$(document).delegate(".selector", "iggriddatabound", function (evt, ui) {
    					//return reference to igGrid
    					ui.owner;
    				});
    
    				//Initialize
    				$(".selector").igGrid({
    					dataBound: function(evt, ui) {...}
    				});
    			 
  • dataRendered

    Cancellable:
    false

    Event fired after all of the data records in the grid table body have been rendered.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

    Code Sample

     
    				//Delegate
    				$(document).delegate(".selector", "iggriddatarendered", function (evt, ui) {
    					//return reference to igGrid
    					ui.owner;
    				});
    
    				//Initialize
    				$(".selector").igGrid({
    					dataRendered: function(evt, ui) {...}
    				});
    			 
  • dataRendering

    Cancellable:
    true

    Event fired before the TBODY holding the data records starts its rendering.
    Return false in order to cancel data records rendering.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

    Code Sample

     
    				//Delegate
    				$(document).delegate(".selector", "iggriddatarendering", function (evt, ui) {
    					//return reference to igGrid
    					ui.owner;
    					//return grid's table body DOM element
    					ui.tbody;
    				});
    
    				//Initialize
    				$(".selector").igGrid({
    					dataRendering: function(evt, ui) {...}
    				});
    			 
  • destroyed

    Cancellable:
    false

    Fired when the grid is destroyed.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

    Code Sample

     
    				//Delegate
    				$(document).delegate(".selector", "igcontroldestroyed", function (evt, ui) {
    					//return reference to igGrid
    					ui.owner;
    				});
    			 
  • footerRendered

    Cancellable:
    false

    Event fired after the footer has been rendered.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

        • table

          Gets a reference to footers table DOM element.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					footerRendered: function(evt, ui) {
    						//return reference to igGrid
    						ui.owner;
    						//return footer html element in the DOM
    						ui.table;
    					}
    				});
    			 
  • footerRendering

    Cancellable:
    true

    Event fired before the footer starts its rendering.

    Return false in order to cancel footer rendering.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					footerRendering: function(evt, ui) {
    						//return reference to igGrid
    						ui.owner;
    					}
    				});
    			 
  • headerCellRendered

    Cancellable:
    false

    Event fired after every TH in the grid header has been rendered.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

        • columnKey
          Type:String

          Gets the column key.

        • th

          Gets a reference to header cell DOM element.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					headerCellRendered: function(evt, ui) {
    						//return reference to igGrid
    						ui.owner;
    						//return column key
    						ui.columnKey;
    						//return header cell DOM element
    						ui.th;
    					}
    				});
    			 
  • headerRendered

    Cancellable:
    false

    Event fired after the header has been rendered.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

        • table

          Gets a reference to headers table DOM element.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					headerRendered: function(evt, ui) {
    						//return reference to igGrid
    						ui.owner;
    						//return headers table DOM element
    						ui.table;
    					}
    				});
    			 
  • headerRendering

    Cancellable:
    true

    Event fired before the header starts its rendering.
    Return false in order to cancel header rendering.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					headerRendering: function(evt, ui) {
    						//return reference to igGrid
    						ui.owner;
    					}
    				});
    			 
  • rendered

    Cancellable:
    false

    Event fired after the whole grid widget has been rendered (including headers, footers, etc.).
    This event is fired only when the grid is being initialized.
    It will not be fired if the grid is rebound to its data
    (for example, when calling the dataBind() API method
    or when changing the page size (when paging is enabled)).

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

    Code Sample

     
    				//Initialize
    				$(".selector").igGrid({
    					rendered: function(evt, ui) {
    						//return reference to igGrid
    						ui.owner;
    					}
    				});
    			 
  • rendering

    Cancellable:
    true

    Event fired before the grid starts rendering (all contents).
    This event is fired only when the grid is being initialized.
    It will not be fired if the grid is rebound to its data
    (for example, when calling the dataBind() API method
    or when changing the page size (when paging is enabled)).
    Return false in order to cancel grid rendering.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

    Code Sample

     
    				//Delegate
    				$(document).delegate(".selector", "iggridrendering", function (evt, ui) {
    					//return reference to igGrid
    					ui.owner;
    				});
    
    				//Initialize
    				$(".selector").igGrid({
    					rendering: function(evt, ui) {...}
    				});
    			 
  • requestError

    Cancellable:
    false

    Event fired if there is an error in the request, when the grid is doing a remote operation,
    such as data binding, paging, sorting, etc.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

        • message
          Type:String

          Gets the processed error message sent by the server.

        • response
          Type:Object

          Gets a reference to the whole response object.

    Code Sample

     
    					//Delegate
    					$(document).delegate(".selector", 'iggridrequesterror', function (evt, ui) {
    						//return reference to igGrid
    						ui.owner
    						//return error message coming from the server
    						ui.message
    					});
    
    					//Initialize
    					$(".selector").igGrid({
    						requestError: function(evt, ui) {...}
    					});
    				 
  • rowsRendered

    Cancellable:
    false

    Event fired after data rows are rendered.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

        • tbody

          Gets reference to the grid's table body.

    Code Sample

     
    				//Delegate
    				$(document).delegate(".selector", "iggridrowsrendered", function (evt, ui) {
    					//return reference to igGrid
    					ui.owner;
    					//return grid's table body DOM element
    					ui.tbody;
    				});
    
    				//Initialize
    				$(".selector").igGrid({
    					rowsRendered: function(evt, ui) {...}
    				});
    			 
  • rowsRendering

    Cancellable:
    true

    Event fired before actual data rows (TRs) are rendered.
    Return false in order to cancel rows rendering.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

        • tbody

          Gets reference to the grid's table body.

    Code Sample

     
    				//Delegate
    				$(document).delegate(".selector", "iggridrowsrendering", function (evt, ui) {
    					//return reference to igGrid
    					ui.owner;
    					//return grid's table body
    					ui.tbody;
    				});
    
    				//Initialize
    				$(".selector").igGrid({
    					rowsRendering: function(evt, ui) {...}
    				});
    			 
  • schemaGenerated

    Cancellable:
    false

    Event fired after $.ig.DataSource schema has been generated, in case it needs to be modified.

    • evt
      Type:Event

      JQuery event object.

    • ui
      Type:Object

        • owner
          Type:Object

          Gets a reference to the grid.

        • schema
          Type:Object

          Gets a reference to data source schema.

        • dataSource
          Type:Object

          Gets reference to data source.

    Code Sample

     
    				//Delegate
    				$(document).delegate(".selector", "iggridschemagenerated", function (evt, ui) {
    					//return reference to igGrid
    					ui.owner;
    					//return data source schema
    					ui.schema;
    					//return reference to data source
    					ui.dataSource;
    				});
    
    				//Initialize
    				$(".selector").igGrid({
    					schemaGenerated: function(evt, ui) {...}
    				});
    			 
  • activeCell

    .igGrid( "activeCell" );
    Return Type:
    object

    Returns the currently active (focused) cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any.

    Code Sample

     
    				var cell = $(".selector").igGrid("activeCell");
    			 
  • activeRow

    .igGrid( "activeRow" );
    Return Type:
    object

    Returns the currently active (focused) row that has the format { element: , index: }, if any.

    Code Sample

     
    				var row = $(".selector").igGrid("activeRow");
    			 
  • allFixedRows

    .igGrid( "allFixedRows" );
    Return Type:
    array

    Returns all data fixed rows recursively, not only the immediate ones(in ColumnFixing scenario - only when there is at least one fixed column).

    Code Sample

     
    				var fixedRows = $(".selector").igGrid("allFixedRows");
    			 
  • allRows

    .igGrid( "allRows" );
    Return Type:
    array

    Returns all data rows recursively, not only the immediate ones(when there is at least one fixed column returns rows only in the UNFIXED table).

    Code Sample

     
    				var rows = $(".selector").igGrid("allRows");
    			 
  • allTransactions

    .igGrid( "allTransactions" );
    Return Type:
    array

    Returns a list of all transaction objects that are either pending, or have been committed in the data source.
    That is a wrapper for this.dataSource.allTransactions().

    Code Sample

     
    				var transactions = $(".selector").igGrid("allTransactions");
    			 
  • autoSizeColumns

    .igGrid( "autoSizeColumns" );

    Auto resize columns that have property width set to "*" so content to be auto-fitted(not shrinked/cutted). Auto-resizing is applied ONLY for visible columns.

    Code Sample

     
    				$(".selector").igGrid("autoSizeColumns");
    			 
  • calculateAutoFitColumnWidth

    .igGrid( "calculateAutoFitColumnWidth", columnIndex:number );
    Return Type:
    number
    Return Type Description:
    Calculated auto-fitted width(-1 if there isn't visible column with the specified columnIndex).

    Calculates the width of the column so its content to be auto-fitted to the width of the data in it(the content should NOT be shrinked/cutted).

    • columnIndex
    • Type:number
    • Visible column index.

    Code Sample

     
    				var autoFitColumnWidth = $(".selector").igGrid("calculateAutoFitColumnWidth", 3);
    			 
  • cellAt

    .igGrid( "cellAt", x:number, y:number, isFixed:bool );
    Return Type:
    domelement
    Return Type Description:
    The cell at (x, y).

    Returns the cell TD element at the specified location.

    • x
    • Type:number
    • The column index.
    • y
    • Type:number
    • The row index.
    • isFixed
    • Type:bool
    • Optional parameter - if true get cell TD at the specified location from the fixed table.

    Code Sample

     
    				var cell = $(".selector").igGrid("cellAt", 3, 4);
    			 
  • cellById

    .igGrid( "cellById", rowId:object, columnKey:string );
    Return Type:
    domelement
    Return Type Description:
    The cell for (rowId, columnKey).

    Returns the cell TD element by row id and column key.

    • rowId
    • Type:object
    • The id of the row.
    • columnKey
    • Type:string
    • The column key.

    Code Sample

     
    				var cell = $(".selector").igGrid("cellById", 3, "ProductName");
    			 
  • children

    .igGrid( "children" );
    Return Type:
    array

    Gets all children's elements of the current grid, recursively.

    Code Sample

     
    				var allChildren = $(".selector").igGrid("children");
    			 
  • childrenWidgets

    .igGrid( "childrenWidgets" );
    Return Type:
    array

    Gets all children of the current grid, recursively.

    Code Sample

     
    				var allChildrenWidgets = $(".selector").igGrid("childrenWidgets");
    			 
  • columnByKey

    .igGrid( "columnByKey", key:string );
    Return Type:
    object
    Return Type Description:
    a column definition.

    Returns a column object by the specified column key.

    • key
    • Type:string
    • The column key.

    Code Sample

     
    				var col = $(".selector").igGrid("columnByKey", "ProductName");
    			 
  • columnByText

    .igGrid( "columnByText", text:string );
    Return Type:
    object
    Return Type Description:
    a column definition.

    Returns a column object by the specified header text. If there are multiple matches, returns the first one.

    • text
    • Type:string
    • The column header text.

    Code Sample

     
    				var col = $(".selector").igGrid("columnByText", "Product Name");
    			 
  • commit

    .igGrid( "commit", [rowId:object] );

    Commits all pending transactions to the client data source. Note that there won't be anything to commit on the UI, since it is updated instantly. In order to rollback the actual UI, a call to dataBind() is required.

    • rowId
    • Type:object
    • Optional
    • If specified, will commit only that transaction corresponding to the specified record key.

    Code Sample

     
    				$(".selector").igGrid("commit");
    			 
  • container

    .igGrid( "container" );
    Return Type:
    domelement

    Returns the DIV that is the topmost container of the grid widget.

    Code Sample

     
    				var containerDiv = $(".selector").igGrid("container");
    			 
  • dataBind

    .igGrid( "dataBind" );

    Causes the grid to data bind to the data source (local or remote) , and re-render all of the data as well.

    Code Sample

     
    				$(".selector").igGrid("dataBind");
    			 
  • dataSourceObject

    .igGrid( "dataSourceObject", dataSource:object );

    If the data source points to a local JSON array of data, and it is necessary to reset it at runtime, it must be done through this API member instead of the options (options.dataSource).

    • dataSource
    • Type:object
    • New data source object.

    Code Sample

     
    				$(".selector").igGrid("dataSourceObject", jsonData);
    			 
  • destroy

    .igGrid( "destroy", notToCallDestroy:object );

    Destroy is part of the jQuery UI widget API and does the following:
    1. Remove custom CSS classes that were added.
    2. Unwrap any wrapping elements such as scrolling divs and other containers.
    3. Unbind all events that were bound.

    • notToCallDestroy
    • Type:object

    Code Sample

     
    					$(".selector").igGrid("destroy");
    				 
  • findRecordByKey

    .igGrid( "findRecordByKey", key:object );
    Return Type:
    object
    Return Type Description:
    a JavaScript object specifying the found record, or null if no record is found.

    Returns a record by a specified key (requires that primaryKey is set in the settings).
    That is a wrapper for this.dataSource.findRecordByKey(key).

    • key
    • Type:object
    • Primary key of the record.

    Code Sample

     
    					var record = $(".selector").igGrid("findRecordByKey", "AR-5381");
    				 
  • fixedBodyContainer

    .igGrid( "fixedBodyContainer" );
    Return Type:
    domelement

    Returns the DIV that is the topmost container of the fixed body grid - contains fixed columns(in ColumnFixing scenario).

    Code Sample

     
    				var fixedBodyContainer = $(".selector").igGrid("fixedBodyContainer");
    			 
  • fixedContainer

    .igGrid( "fixedContainer" );
    Return Type:
    domelement

    Returns the DIV that is the topmost container of the fixed grid - contains fixed columns(in ColumnFixing scenario).

    Code Sample

     
    				var fixedContainer = $(".selector").igGrid("fixedContainer");
    			 
  • fixedFooterContainer

    .igGrid( "fixedFooterContainer" );
    Return Type:
    object
    Return Type Description:
    jQuery representation of fixed table.

    Returns container(jQuery representation) containing fixed footer - contains fixed columns(in ColumnFixing scenario).

    Code Sample

     
    				var fixedFooterContainer = $(".selector").igGrid("fixedFooterContainer");
    			 
  • fixedFootersTable

    .igGrid( "fixedFootersTable" );
    Return Type:
    domelement

    Returns the table that contains the footer cells - contains fixed columns(in ColumnFixing scenario).

    Code Sample

     
    				var fixedFootersTable = $(".selector").igGrid("fixedFootersTable");
    			 
  • fixedHeaderContainer

    .igGrid( "fixedHeaderContainer" );
    Return Type:
    object
    Return Type Description:
    jQuery representation of fixed table.

    Returns container(jQuery representation) containing fixed header - contains fixed columns(in ColumnFixing scenario).

    Code Sample

     
    				var fixedHeaderContainer = $(".selector").igGrid("fixedHeaderContainer");
    			 
  • fixedHeadersTable

    .igGrid( "fixedHeadersTable" );
    Return Type:
    domelement

    Returns the table that contains the FIXED header cells - contains fixed columns(in ColumnFixing scenario).

    Code Sample

     
    				var fixedHeadersTable = $(".selector").igGrid("fixedHeadersTable");
    			 
  • fixedRowAt

    .igGrid( "fixedRowAt", i:number );
    Return Type:
    domelement
    Return Type Description:
    the row at the specified index.

    Returns the fixed row (TR element) at the specified index. jQuery selectors aren't used for performance reasons(in ColumnFixing scenario - only when there is at least one fixed column).

    • i
    • Type:number
    • The row index.

    Code Sample

     
    				var fixedRow = $(".selector").igGrid("fixedRowAt", 10);
    			 
  • fixedRows

    .igGrid( "fixedRows" );
    Return Type:
    array

    Returns a list of all fixed TR elements holding data in the grid(in ColumnFixing scenario - only when there is at least one fixed column).

    Code Sample

     
    				var fixedRows = $(".selector").igGrid("fixedRows");
    			 
  • fixedTable

    .igGrid( "fixedTable" );
    Return Type:
    object
    Return Type Description:
    jQuery representation of fixed table.

    Returns the fixed table - contains fixed columns(in ColumnFixing scenario). If there aren't fixed columns returns the grid table.

    Code Sample

     
    				var fixedTable = $(".selector").igGrid("fixedTable");
    			 
  • fixingDirection

    .igGrid( "fixingDirection" );
    Return Type:
    enumeration
    Return Type Description:
    Can return 'left|right'.

    Returns the current fixing direction. NOTE - use only if ColumnFixing feature is enabled.

    Code Sample

     
    				var fixingDirection = $(".selector").igGrid("fixingDirection");
    			 
  • footersTable

    .igGrid( "footersTable" );
    Return Type:
    domelement

    Returns the table that contains the footer cells.

    Code Sample

     
    				var footer = $(".selector").igGrid("footersTable");
    			 
  • getCellText

    .igGrid( "getCellText", rowId:object, colKey:string );
    Return Type:
    string
    Return Type Description:
    the cell text for the respective cell.

    Returns the cell text. If colKey is a number, the index of the column is used (instead of a column name)- does not apply when using a Multi-Row Layout grid.
    This is the actual text (or HTML string) for the contents of the cell.

    • rowId
    • Type:object
    • Row index or row data key (primary key).
    • colKey
    • Type:string
    • Column key.

    Code Sample

     
    					var text = $(".selector").igGrid("getCellText", 3, "ProductName");
    				 
  • getCellValue

    .igGrid( "getCellValue", rowId:object, colKey:string );
    Return Type:
    object
    Return Type Description:
    The corresponding cell value.

    Retrieves a cell value using the row index and the column key. If a primaryKey is defined, rowId is assumed to be the row Key (not index).
    If primary key is not defined, then rowId is converted to a number and is used as a row index.

    • rowId
    • Type:object
    • Row index or row key (primary key).
    • colKey
    • Type:string
    • The column key.

    Code Sample

     
    					var date = $(".selector").igGrid("getCellValue", 3, "ShipDate");
    				 
  • getColumnByTD

    .igGrid( "getColumnByTD", $td:object );
    Return Type:
    object
    Return Type Description:
    object that contains the column object and the visible index to which the cell belongs to.

    Returns column object and visible index for the table cell(TD) which is passed as argument.

    • $td
    • Type:object
    • cell(TD) - either DOM TD element or jQuery object.

    Code Sample

     
    				var columnObject = $(".selector").igGrid("getColumnByTD", $(".cellSelector"));
    			 
  • getDetachedRecord

    .igGrid( "getDetachedRecord", t:object );
    Return Type:
    object
    Return Type Description:
    A copy of a record from the data source.

    Returns a standalone object (copy) that represents the committed transactions, but detached from the data source.
    That is a wrapper for this.dataSource.getDetachedRecord(t).

    • t
    • Type:object
    • A transaction object.

    Code Sample

     
    					var ds = $(".selector").igGrid("option", "dataSource");
    					var transactionObject = ds.addRow(123, {
    						Name: "CD Player",
    						Price: "40",
    						Rating: "4"
    						}, true);
    					var record = $(".selector").igGrid("getDetachedRecord", transactionObject);
    				 
  • getElementInfo

    .igGrid( "getElementInfo", elem:domelement );
    Return Type:
    object
    Return Type Description:
    Object that contains the following information on the passed DOM element:.

    Returns an object that contains information on the passed Dom element

    rowId - the id of the record associated with the element - if primaryKey is not set this will be null.
    rowIndex - the index (in the DOM) of the row associated with the element.
    recordIndex - index of the data record associated with this element in the current dataView.
    columnObject - the column object associated with this element ( if the element is tr this will be null).

    • elem
    • Type:domelement
    • The Dom element or jQuery object which can be a TD or TR element from the grid.

    Code Sample

     
    			var info = $(".selector").igGrid("getElementInfo", $(".elementSelector"));
    		 
  • getUnboundColumnByKey

    .igGrid( "getUnboundColumnByKey", key:string );
    Return Type:
    object
    Return Type Description:
    a column definition.

    Returns an unbound column with the specified key. If not found returns null.

    • key
    • Type:string
    • a column key.

    Code Sample

     
    				// returns the unbound column with key "Total"
    				var totalUC = $('.selector').igGrid('getUnboundColumnByKey', 'Total');
    			 
  • getUnboundValues

    .igGrid( "getUnboundValues", key:string );
    Return Type:
    object
    Return Type Description:
    unbound values.

    Gets unbound values for the specified column key. If key is not specified returns all unboundvalues.

    • key
    • Type:string
    • column key.

    Code Sample

     
    				// returns the array of unbound values for the unbound column with key = "Total"
    				var unboundValues = $('.selector').igGrid('getUnboundValues', 'Total');
    
    				// returns all unbound values in the igGrid
    				var allUnboundValues = $('.selector').igGrid('getUnboundValues');
    
    				// returns null if BoundColumnKey is a key of a bound column
    				var boundColumnValues = $('.selector').igGrid('getUnboundValues', 'BoundColumnKey');
    			 
  • getVisibleIndexByKey

    .igGrid( "getVisibleIndexByKey", columnKey:string, includeDataSkip:bool );
    Return Type:
    number
    Return Type Description:
    returns visible index. If column is not found or column is hidden returns -1.

    Get visible index by specified column key. If column is not found or is hidden then returns -1.
    Note: Method does not count column groups (Multi-Column Headers).

    • columnKey
    • Type:string
    • columnKey.
    • includeDataSkip
    • Type:bool
    • Optional parameter - if set to true include non data columns(like expander column, row selectors column, etc.) in calculations.

    Code Sample

     
    					var visibleIndexByKey = $(".selector").igGrid("getVisibleIndexByKey", "ProductName");
    				 
  • hasFixedColumns

    .igGrid( "hasFixedColumns" );
    Return Type:
    bool

    Returns true if grid has at least one fixed columns(even if a non-data column - like row-selectors column).

    Code Sample

     
    				var hasFixedColumns = $(".selector").igGrid("hasFixedColumns");
    			 
  • hasFixedDataSkippedColumns

    .igGrid( "hasFixedDataSkippedColumns" );
    Return Type:
    bool

    Returns whether grid has non-data fixed columns(e.g. row selectors column).

    Code Sample

     
    				var hasFixedDataSkippedColumns = $(".selector").igGrid("hasFixedDataSkippedColumns");
    			 
  • hasVerticalScrollbar

    .igGrid( "hasVerticalScrollbar" );

    Returns whether there is vertical scrollbar. Because of perfrormance issues in older Internet Explorer especially 8,9 - there is no need to check if height is not set - there is no scrollbar OR if row virtualization is enabled - it is supposed there is vertical scrollbar.

    Code Sample

     
    				var hasVerticalScrollbar = $(".selector").igGrid("hasVerticalScrollbar");
    			 
  • headersTable

    .igGrid( "headersTable" );
    Return Type:
    domelement

    Returns the table that contains the header cells.

    Code Sample

     
    				var headers = $(".selector").igGrid("headersTable");
    			 
  • hideColumn

    .igGrid( "hideColumn", column:object, callback:function );

    Hides a visible column. If the column is hidden the method does nothing.
    Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method.

    • column
    • Type:object
    • An identifier for the column. If a number is provided it will be used as a column index else if a string is provided it will be used as a column key.
    • callback
    • Type:function
    • Specifies a custom function to be called when the column is hidden(optional).

    Code Sample

     
    					$(".selector").igGrid("hideColumn", 1);
    					$(".selector").igGrid("hideColumn", "ProductID");
    				 
  • id

    .igGrid( "id" );
    Return Type:
    string

    Returns the ID of the TABLE element where data records are rendered.

    Code Sample

     
    				var id = $(".selector").igGrid("id");
    			 
  • immediateChildren

    .igGrid( "immediateChildren" );
    Return Type:
    array

    Gets all immediate children's elements of the current grid.

    Code Sample

     
    				var children = $(".selector").igGrid("immediateChildren");
    			 
  • immediateChildrenWidgets

    .igGrid( "immediateChildrenWidgets" );
    Return Type:
    array

    Gets all immediate children of the current grid.

    Code Sample

     
    				var childrenWidgets = $(".selector").igGrid("immediateChildrenWidgets");
    			 
  • isFixedColumn

    .igGrid( "isFixedColumn", colKey:object );
    Return Type:
    bool

    Returns whether the column with identifier colKey is fixed.

    • colKey
    • Type:object
    • An identifier of the column which should be checked. It can be a key or visible index.

    Code Sample

     
    				var isFixedColumn = $(".selector").igGrid("isFixedColumn", "Name");
    			 
  • isGroupHeader

    .igGrid( "isGroupHeader", colKey:string );

    Returns whether the header identified by colKey is multicolumn header(has children).

    • colKey
    • Type:string
    • value of the column key.
  • moveColumn

    .igGrid( "moveColumn", column:object, target:object, [after:bool], [inDom:bool], [callback:function] );

    Moves a visible column at a specified place, in front or behind a target column or at a target index
    Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method.

    • column
    • Type:object
    • An identifier of the column to be moved. It can be a key, a Multi-Column Header identificator, or an index in a number format. The latter is not supported when the grid contains multi-column headers.
    • target
    • Type:object
    • An identifier of a column where the moved column should move to or an index at which the moved column should be moved to. In the case of a column identifier the column will be moved after it by default.
    • after
    • Type:bool
    • Optional
    • Specifies whether the column moved should be moved after or before the target column. This parameter is disregarded if there is no target column specified but a target index is used.
    • inDom
    • Type:bool
    • Optional
    • Specifies whether the column moving will be enacted through DOM manipulation or through rerendering of the grid.
    • callback
    • Type:function
    • Optional
    • Specifies a custom function to be called when the column is moved.

    Code Sample

     
    				$(".selector").igGrid("moveColumn", "CustomerID", "Address", false, true);
    				// OR
    				$(".selector").igGrid("moveColumn", "CustomerID", "Address", false, true, function () {
    					// Custom code executed after the move operation finishes
    				});
    			 
  • pendingTransactions

    .igGrid( "pendingTransactions" );
    Return Type:
    array

    Returns a list of all transaction objects that are pending to be committed or rolled back to the data source.
    That is a wrapper for this.dataSource.pendingTransactions().

    Code Sample

     
    					var pendingTrans = $(".selector").igGrid("pendingTransactions");
    				 
  • renderMultiColumnHeader

    .igGrid( "renderMultiColumnHeader", cols:array );

    When called the method re-renders the whole grid(also rebinds to the data source) and renders the cols object.

    • cols
    • Type:array
    • An array of column objects.

    Code Sample

     
    				var columns = [
    					{ headerText: "Customer ID", key: "CustomerID", dataType: "string", width: "100px" },
    					{ headerText: "Company Information",
    						group: [
    							{ headerText: "Company Name", key: "CompanyName", dataType: "string", width: "150px" },
    							{ headerText: "Contact Name", key: "ContactName", dataType: "string", width: "150px" },
    							{ headerText: "Contact Title", key: "ContactTitle", dataType: "string", width: "150px" }
    						]
    					}
    				];
    				$(".selector").igGrid("renderMultiColumnHeader", columns);
    			 
  • renderNewRow

    .igGrid( "renderNewRow", [rec:string] );

    Adds a new row (TR) to the grid, by taking a data row object. Assumes the record will have the primary key.

    • rec
    • Type:string
    • Optional
    • Identifier/key of row. If missing, then number of rows in grid is used.

    Code Sample

     
    				$(".selector").igGrid("renderNewRow", {
    					ProductID: 2,
    					Name: "CD Player",
    					ProductNumber: "test",
    					Color: "test",
    					StandardCost: 40,
    				});
    			 
  • resizeContainer

    .igGrid( "resizeContainer" );

    Called to detect whether grid container is resized. When autoAdjustHeight is true and height of the grid is changed then the height of grid is re-set.

    Code Sample

     
    			$(".selector").igGrid("resizeContainer");
    			 
  • rollback

    .igGrid( "rollback", [rowId:object], [updateUI:bool] );
    Return Type:
    array
    Return Type Description:
    The transactions that have been rolled back.

    Clears the transaction log (delegates to igDataSource). Note that this does not update the UI. In case the UI must be updated, set the second parameter "updateUI" to true, which will trigger a call to dataBind() to re-render the contents.

    • rowId
    • Type:object
    • Optional
    • If specified, will only rollback the transactions with that row id.
    • updateUI
    • Type:bool
    • Optional
    • Whether to update the UI or not.

    Code Sample

     
    				$(".selector").igGrid("rollback", 5, true);
    			 
  • rowAt

    .igGrid( "rowAt", i:number );
    Return Type:
    domelement
    Return Type Description:
    the row at the specified index.

    Returns the row (TR element) at the specified index. jQuery selectors aren't used for performance reasons.

    • i
    • Type:number
    • The row index.

    Code Sample

     
    				var row = $(".selector").igGrid("rowAt", 5);
    			 
  • rowById

    .igGrid( "rowById", rowId:object, [isFixed:bool] );
    Return Type:
    domelement
    Return Type Description:
    The row for (rowId).

    Returns the row TR element by row id.

    • rowId
    • Type:object
    • The id of the row.
    • isFixed
    • Type:bool
    • Optional
    • Specify search in the fixed container.

    Code Sample

     
    				var row = $(".selector").igGrid("rowById", 1);
    			 
  • rows

    .igGrid( "rows" );
    Return Type:
    array

    Returns a list of all TR elements holding data in the grid(when there is at least one fixed column returns rows only in the UNFIXED table).

    Code Sample

     
    				var rows = $(".selector").igGrid("rows");
    			 
  • saveChanges

    .igGrid( "saveChanges", success:function, error:function );

    Invokes an AJAX request to the updateUrl option (if specified) and passes the serialized transaction log (a serialized JSON string) as part of the POST request.

    • success
    • Type:function
    • Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional).
    • error
    • Type:function
    • Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional).

    Code Sample

     
    				// Example 1: Save changes without callbacks
    				$(".selector").igGrid("saveChanges");
    
    				// Example 2: Save changes with success and error callbacks
    				$(".selector").igGrid("saveChanges", function (data) {
    					$("#message").text("Changes were saved successfully").fadeIn(3000).fadeOut(5000);
    				},
    				function(jqXHR, textStatus, errorThrown) {
    					$("#message").text("An error occurred while saving the changes. Error details: " + textStatus).fadeIn(3000).fadeOut(5000);
    				});
    			 
  • scrollContainer

    .igGrid( "scrollContainer" );
    Return Type:
    domelement

    Returns the DIV that is used as a scroll container for the grid contents.

    Code Sample

     
    				var container = $(".selector").igGrid("scrollContainer");
    			 
  • selectedCell

    .igGrid( "selectedCell" );
    Return Type:
    object

    Returns the currently selected cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any.
    If multiple selection is enabled the function will return null.

    Code Sample

     
    				var cell = $(".selector").igGrid("selectedCell");
    			 
  • selectedCells

    .igGrid( "selectedCells" );
    Return Type:
    array

    Returns an array of selected cells in arbitrary order where every objects has the format { element: , row: , index: , rowIndex: , columnKey: } .
    If multiple selection is disabled the function will return null.

    Code Sample

     
    				var cells = $(".selector").igGrid("selectedCells");
    			 
  • selectedRow

    .igGrid( "selectedRow" );
    Return Type:
    object

    Returns the currently selected row that has the format { element: , index: }, if any.
    If multiple selection is enabled the function will return null.

    Code Sample

     
    				var row = $(".selector").igGrid("selectedRow");
    			 
  • selectedRows

    .igGrid( "selectedRows" );
    Return Type:
    array

    Returns an array of selected rows in arbitrary order where every object has the format { element: , index: } .
    If multiple selection is disabled the function will return null.

    Code Sample

     
    				var rows = $(".selector").igGrid("selectedRows");
    			 
  • setColumnTemplate

    .igGrid( "setColumnTemplate", col:object, tmpl:string, [render:bool] );

    Sets a new template for a column after initialization and renders the grid if not explicitly disabled. This method will replace any existing explicitly set row template and will build one anew from the column ones.

    • col
    • Type:object
    • An identifier of the column to set template for (index or key).
    • tmpl
    • Type:string
    • The column template to set.
    • render
    • Type:bool
    • Optional
    • Should the grid rerender after template is set.

    Code Sample

     
    				$(".selector").igGrid("setColumnTemplate", "Name", "<img src='${ImageUrl}'/>", true);
    			 
  • setUnboundValueByPK

    .igGrid( "setUnboundValueByPK", col:string, rowId:string, val:object, notToRender:object );

    Sets unbound value for the unbound cell by the specified column key and row primary key.

    • col
    • Type:string
    • key of the unbound column.
    • rowId
    • Type:string
    • primary key value of the row.
    • val
    • Type:object
    • value to be set on unbound cell.
    • notToRender
    • Type:object
    • if false will re-render the row.

    Code Sample

     
    				//IsPromotion is the key of an unbound column and 2 is the id of the row being affected based on the primaryКey column. The new value for the cell would be true and notToRender - false will re-render the row
    
    				$(".selector").igGrid("setUnboundValueByPK", "IsPromotion", 2, true, false);
    			 
  • setUnboundValues

    .igGrid( "setUnboundValues", key:string, values:array, removeOldValues:object );

    Sets unbound values for the unbound column with the specified key. If removeOldValues is true then values(if any) for the unbound columns are re-set with the new values.

    • key
    • Type:string
    • key of the unbound column.
    • values
    • Type:array
    • array of values to be set on unbound values.
    • removeOldValues
    • Type:object
    • if true removes current unbound values(if any) for the specified column and apply the new ones specified in parameter values. Otherwise merge current values with the specified in parameter values.

    Code Sample

     
    				// PromotionExpDate is the key of an unbound column. The array of dates is used to set unbound values
    
    				$(".selector").igGrid("setUnboundValues", "PromotionExpDate", [new Date('4/24/2012'), new Date('8/24/2012'), new Date('6/24/2012'), new Date('7/24/2012')]);
    			 
  • showColumn

    .igGrid( "showColumn", column:object, callback:function );

    Shows a hidden column. If the column is not hidden the method does nothing.
    Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method.

    • column
    • Type:object
    • An identifier for the column. If a number is provided it will be used as a column index. If a string is provided it will be used as a column key.
    • callback
    • Type:function
    • Specifies a custom function to be called when the column is shown(optional).

    Code Sample

     
    				$(".selector").igGrid("showColumn", 1);
    				$(".selector").igGrid("showColumn", "ProductID");
    			 
  • totalRecordsCount

    .igGrid( "totalRecordsCount" );
    Return Type:
    number
    Return Type Description:
    total number of records in the backend.

    Returns the total number of records in the underlying backend. If paging or filtering is enabled, this may differ from the number of records in the client-side data source.
    In order for this to work, the response JSON/XML must include a property that specifies the total number of records, which name is specified by options.responseTotalRecCountKey.
    This functionality is completely delegated to the data source control.

    Code Sample

     
    				var count = $(".selector").igGrid("totalRecordsCount");
    			 
  • transactionsAsString

    .igGrid( "transactionsAsString" );
    Return Type:
    string

    Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently.
    That is a wrapper for this.dataSource.transactionsAsString().

    Code Sample

     
    				var transactionsString = $(".selector").igGrid("transactionsAsString");
    			 
  • virtualScrollTo

    .igGrid( "virtualScrollTo", scrollerPosition:object );

    Scroll to the specified row or specified position(in pixels).

    • scrollerPosition
    • Type:object
    • An identifier of the vertical scroll position. When it is string then it is interpreted as pixels otherwise it is the row number.

    Code Sample

     
    				$(".selector").igGrid("virtualScrollTo", scrollContainerTop);
    			 
  • widget

    .igGrid( "widget" );

    Returns the element holding the data records.

    Code Sample

     
    				var grid = $(".selector").igGrid("widget");
    			 
  • ui-widget ui-helper-clearfix ui-corner-all

    Classes applied to the top container element.
  • ui-widget-content

    Widget content class applied to various content containers in the grid.
  • ui-widget-header

    JQuery UI class applied to the grid header elements.
  • ui-iggrid-deletedrecord

    Classes applied to the deleted rows of grid before commit.
  • ui-iggrid-captiontable

    When no headers are shown or fixed headers is false, the caption (if any) needs to be rendered in a separate table.
  • ui-iggrid

    Class applied to the top container element.
  • ui-iggrid-footercaption

    Classes applied to the grid footer caption contents.
  • ui-iggrid-footertable ui-widget-footer

    When fixed footers is enabled, this class is applied to the table that holds the footer TD elements.
  • ui-iggrid-headercaption ui-widget-header ui-corner-top

    Classes applied to the element that's on top of the header that has some description.
  • ui-iggrid-headertable

    When fixed headers is enabled, this class is applied to the table that holds the header TH elements.
  • ui-iggrid-measurement-container

    Class appplied to the hidden DIV container used for measurement of width of auto resizable columns.
  • ui-iggrid-scrolldiv ui-widget-content

    Classes applied to the scrolling div container when width and height are defined and scrollbars is 'true'.
  • ui-iggrid-tablebody

    Class applied to the TABLE's TBODY holding data records.
  • ui-iggrid-table ui-widget-content

    Classes applied to the TABLE which holds the grid records.
  • ui-iggrid-virtualscrolldiv

    Classes applied to the scrolling div container when virtualization is enabled.
  • ui-iggrid-headercell-featureenabled

    Classes which will be applied to the grid header cell element when feature icon is rendered.
  • ui-iggrid-header ui-widget-header

    Classes applied to the grid header elements.
  • ui-iggrid-headertext

    Classes applied to the header text container.
  • ui-iggrid-modifiedrecord

    Classes applied to the modified rows of grid before commit.
  • ui-iggrid-headertable-mrl

  • ui-iggrid-table-mrl ui-widget-content

  • ui-ig-altrecord ui-iggrid-altrecord

    Classes applied on alternate records.
  • ui-ig-record ui-iggrid-record

    Classes applied to the TBODY, and inherited through css for the records.
  • ui-iggrid-rtl

    Class appplied to the grid element when RTL is enabled.

Copyright © 1996 - 2017 Infragistics, Inc. All rights reserved.