ui.igGridRowSelectors

ui.igGridRowSelectors_image

Both the igGrid and igHierarchicalGrid controls feature row selection in the grid. Using row selectors you can configure the control to select single or multiple rows in the grid. You may also optionally enable row numbering with row selection. Further information regarding the classes, options, events, methods and themes of this API are available under the associated tabs above.

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

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

Code Sample

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

Related Samples

Related Topics

Dependencies

jquery-1.9.1.js
jquery.ui.core.js
jquery.ui.widget.js
infragistics.ui.grid.framework.js
infragistics.ui.editors.js
infragistics.ui.shared.js
infragistics.datasource.js
infragistics.util.js

Inherits

  • deselectAllForPagingTemplate

    Type:
    string
    Default:
    null

    Custom template for "deselect all" overlay with paging
    Element with attribute data-rs-deselect-all is used for sellecting all the records
    Element with attribute data-rs-close-all is used for closing the overlay
    The default template is "<div class='ui-widget-header ui-priority-secondary' tabindex='0'><div>You have deselected ${unchecked} records. <a href='#' tabindex='0' data-rs-deselect-all>Deselect all ${totalRecordsCount} records</a><div style='float:right;'><span data-rs-close-all class='ui-icon-close ui-icon ui-button' tabindex='0'></div></span></div></div>"
    There is also ${allCheckedRecords} parameter which is not used in the default template, but it represents the checked records from all pages.

    Code Sample

     
				//Initialize
				$(".selector").igGrid({
					features : [
						{
							name : "RowSelectors",
							enableCheckBoxes: true,
							enableSelectAllForPaging: true,
							deselectAllForPagingTemplate: "<div class='ui-widget-header ui-priority-secondary' tabindex='0'><div><a href='#' tabindex='0' data-rs-deselect-all>Deselect all ${totalRecordsCount} records</a><div style='float:right;'><span data-rs-close-all class='ui-icon-close ui-icon ui-button' tabindex='0'></div></span></div></div>"
						},
						{
							name: "Selection",
							multipleSelection: true
						},
						{
							name: 'Paging',
							type: "local",
							pageSize: 10
						}
					]
				});

				//Get
				var template = $(".selector").igGridRowSelectors("option", "deselectAllForPagingTemplate");

  • enableCheckBoxes

    Type:
    bool
    Default:
    false

    Determines whether the row selectors column should contain checkboxes.

    Code Sample

     
				//Initialize
				$(".selector").igGrid({
					features : [
						{
							name : "RowSelectors",
							enableCheckBoxes: true
						},
						{
							name: "Selection"
						}
					]
				});

				//Get
				var checkboxes = $(".selector").igGridRowSelectors("option", "enableCheckBoxes");

  • enableRowNumbering

    Type:
    bool
    Default:
    true

    Determines whether the row selectors column should contain row numbering.

    Code Sample

     
				//Initialize
				$(".selector").igGrid({
					features : [
						{
							name : "RowSelectors",
							enableRowNumbering: true
						},
						{
							name: "Selection"
						}
					]
				});

				//Get
				var rowNumbering = $(".selector").igGridRowSelectors("option", "enableRowNumbering");

  • enableSelectAllForPaging

    Type:
    bool
    Default:
    true

    Enables/disables showing an overlay after clicking on the header checkbox, which allows selecting all records from all pages.

    Code Sample

     
				//Initialize
				$(".selector").igGrid({
					features : [
						{
							name : "RowSelectors",
							enableCheckBoxes: true,
							enableSelectAllForPaging: true
						},
						{
							name: "Selection",
							multipleSelection: true
						},
						{
							name: 'Paging',
							type: "local",
							pageSize: 10
						}
					]
				});

				//Get
				var enableSelectAll = $(".selector").igGridRowSelectors("option", "enableSelectAllForPaging");

  • inherit

    Type:
    bool
    Default:
    false

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

  • locale

    Type:
    object
    Default:
    {}

    • deselectAllText

      Type:
      string
      Default:
      ""

      Deselect all text for the select/deselect all overlay.

      Code Sample

       
				//Initialize
				$(".selector").igGrid({
					features: [{
						name: "RowSelectors",
						locale: {
							deselectAllText: "Deselect all ${totalRecordsCount} records"
						}
					}]
				});

				//	Get
				var text = $(".selector").igGridRowSelectors("option", "locale").deselectAllText;

				//	Set
				$(".selector").igGridRowSelectors("option", "locale", { deselectAllText: "Deselect all ${totalRecordsCount} records"});

    • deselectedRecordsText

      Type:
      string
      Default:
      ""

      Deselected records text for the select/deselect all overlay.

      Code Sample

       
				//Initialize
				$(".selector").igGrid({
					features: [{
						name: "RowSelectors",
						locale: {
							deselectedRecordsText: "You have deselected ${unchecked} records."
						}
					}]
				});

				//	Get
				var text = $(".selector").igGridRowSelectors("option", "locale").deselectedRecordsText;

				//	Set
				$(".selector").igGridRowSelectors("option", "locale", { deselectedRecordsText: "You have deselected ${unchecked} records." });

    • selectAllText

      Type:
      string
      Default:
      ""

      Select all text for the select/deselect all overlay.

      Code Sample

       
				//Initialize
				$(".selector").igGrid({
					features: [{
						name: "RowSelectors",
						locale: {
							selectAllText: "Select all ${totalRecordsCount} records"
						}
					}]
				});

				//	Get
				var text = $(".selector").igGridRowSelectors("option", "locale").selectAllText;

				//	Set
				$(".selector").igGridRowSelectors("option", "locale", { selectAllText: "Select all ${totalRecordsCount} records."});

    • selectedRecordsText

      Type:
      string
      Default:
      ""

      Selected records text for the select/deselect all overlay.

      Code Sample

       
				//Initialize
				$(".selector").igGrid({
					features: [{
						name: "RowSelectors",
						locale: {
							selectedRecordsText: "You have selected ${checked} records."
						}
					}]
				});

				//	Get
				var text = $(".selector").igGridRowSelectors("option", "locale").selectedRecordsText;

				//	Set
				$(".selector").igGridRowSelectors("option", "locale", { selectedRecordsText: "You have selected ${checked} records." });

  • requireSelection

    Type:
    bool
    Default:
    true

    Determines whether the selection feature is required for the row selectors. If set to "false"
    the widget will not check for Selection availability. If set to "true" an exception will be thrown if Selection is
    not available.

    Code Sample

     
				//Initialize
				$(".selector").igGrid({
					features : [
						{
							name : "RowSelectors",
							requireSelection: true
						},
						{
							name: "Selection"
						}
					]
				});

				//Get
				var requireSelection = $(".selector").igGridRowSelectors("option", "requireSelection");

  • rowNumberingSeed

    Type:
    number
    Default:
    0

    The seed to be added to the default numbering.

    Code Sample

     
				//Initialize
				$(".selector").igGrid({
					features : [
						{
							name : "RowSelectors",
							rowNumberingSeed: 5
						},
						{
							name: "Selection"
						}
					]
				});

				//Get
				var rowNumberingSeed = $(".selector").igGridRowSelectors("option", "rowNumberingSeed");

  • rowSelectorColumnWidth

    Type:
    enumeration
    Default:
    null

    defines width of the row selector`s column in pixels or percentage.

    Members

    • string
    • Type:string
    • The row selector column width can be set in pixels (px) and percentage (%).
    • number
    • Type:number
    • The row selector width can be set as a number.
    • null
    • Type:object
    • will let the feature decide the best width depending on enabled contents.

    Code Sample

     
				//Initialize
				$(".selector").igGrid({
					features : [
						{
							name : "RowSelectors",
							rowSelectorColumnWidth: 40
						},
						{
							name: "Selection"
						}
					]
				});
				//Get
				var width = $(".selector").igGridRowSelectors("option", "rowSelectorColumnWidth");

  • selectAllForPagingTemplate

    Type:
    string
    Default:
    null

    Custom template for "select all" overlay with paging
    Element with attribute data-rs-select-all is used for sellecting all the records
    Element with attribute data-rs-close-all is used for closing the overlay
    The default template is "<div class='ui-widget-header ui-priority-secondary' tabindex='0'><div>You have selected ${checked} records. <a href='#' tabindex='0' data-rs-select-all>Select all ${totalRecordsCount} records</a><div style='float:right;'><span data-rs-close-all class='ui-icon-close ui-icon ui-button' tabindex='0'></div></span></div></div>"
    There is also ${allCheckedRecords} parameter which is not used in the default template, but it represents the checked records from all pages.

    Code Sample

     
				//Initialize
				$(".selector").igGrid({
					features : [
						{
							name : "RowSelectors",
							enableCheckBoxes: true,
							enableSelectAllForPaging: true,
							selectAllForPagingTemplate: "<a data-rs-select-all>Click here if you want to select all ${totalRecordsCount} records</a><span data-rs-close-all></span>"
						},
						{
							name: "Selection",
							multipleSelection: true
						},
						{
							name: 'Paging',
							type: "local",
							pageSize: 10
						}
					]
				});

				//Get
				var template = $(".selector").igGridRowSelectors("option", "selectAllForPagingTemplate");

				//Set
				var templateStr = "<a data-rs-select-all>Click here if you want to select all ${totalRecordsCount} records</a><span data-rs-close-all></span>";
				$(".selector").igGridRowSelectors("option", "selectAllForPagingTemplate", templateStr);

  • showCheckBoxesOnFocus

    Type:
    bool
    Default:
    false

    Determines whether checkboxes will be shown only if row selectors are on focus/selected.

    Code Sample

     
				//Initialize
				$(".selector").igGrid({
					features : [
						{
							name : "RowSelectors",
							showCheckBoxesOnFocus: true
						},
						{
							name: "Selection"
						}
					]
				});

				//Get
				var showCheckboxes = $(".selector").igGridRowSelectors("option", "showCheckBoxesOnFocus");

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

  • checkBoxStateChanged

    Cancellable:
    false

    Event fired after a row selector checkbox had changed state.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • row
          Type: jQuery

          Gets a reference to the row the clicked row selector resides in.

        • rowIndex
          Type: Number

          Gets the index of the row the clicked row selector resides in.

        • rowKey
          Type: String

          Gets the key of the row the clicked row selector resides in.

        • rowSelector
          Type: jQuery

          Gets reference to the row selector cell.

        • owner
          Type: Object

          Gets reference to the igGridRowSelectors.

        • grid
          Type: Object

          Gets reference to the grid the RowSelectors are initialized for.

        • state
          Type: String

          Gets the state of the checkbox ("on","off").

        • isHeader
          Type: Bool

          Checks if the header check box is the one being clicked. In this case no row related args are passed.

    Code Sample

     
				//Bind after initialization
				$(document).delegate(".selector", "iggridrowselectorscheckboxstatechanged", function (evt, ui) {
					//return the triggered event
					evt;

					// reference to the row the clicked row selector resides in
					ui.row;

					// get the index of the row the clicked row selector resides in
					ui.rowIndex;

					// get the key of the row the clicked row selector resides in
					ui.rowKey;

					// get reference to the row selector cell
					ui.rowSelector;

					// get reference to the grid the RowSelectors are initialized for
					ui.grid;

					// get the state of the checkbox ("on","off")
					ui.state;

					// check if the header row checkbox is clicked
					ui.isHeader;

				});

				//Initialize
				$(".selector").igGrid({
					features : [
						{
							name : "RowSelectors",
							checkBoxStateChanged: function(evt, ui){ ... }
						}
					]
				});

  • checkBoxStateChanging

    Cancellable:
    true

    Event fired when a row selector checkbox is changing.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • row
          Type: jQuery

          Gets a reference to the row the clicked row selector resides in.

        • rowIndex
          Type: Number

          Gets the index of the row the clicked row selector resides in.

        • rowKey
          Type: Object

          Gets the key of the row the clicked row selector resides in.

        • rowSelector
          Type: jQuery

          Gets a reference to the row selector cell.

        • owner
          Type: Object

          Gets a reference to the igGridRowSelectors.

        • grid
          Type: Object

          Gets a reference to the grid the RowSelectors are initialized for.

        • currentState
          Type: String

          Gets the current state of the checkbox ("on","off").

        • newState
          Type: String

          Gets the new state of the checkbox ("on","off").

        • isHeader
          Type: Bool

          Checks if the header check box is the one being clicked. In this case no row related args are passed.

    Code Sample

     
				//Bind after initialization
				$(document).delegate(".selector", "iggridrowselectorscheckboxstatechanging", function (evt, ui) {
					//return the triggered event
					evt;

					// reference to the row the clicked row selector resides in
					ui.row;

					// get the index of the row the clicked row selector resides in
					ui.rowIndex;

					// get the key of the row the clicked row selector resides in
					ui.rowKey;

					// get reference to the row selector cell
					ui.rowSelector;

					// get reference to the grid the RowSelectors are initialized for
					ui.grid;

					// get the current state of the checkbox ("on","off")
					ui.currentState;

					// get the new state of the checkbox ("on","off")
					ui.newState;

					// check if the header row checkbox is clicked
					ui.isHeader;

				});

				//Initialize
				$(".selector").igGrid({
					features : [
						{
							name : "RowSelectors",
							checkBoxStateChanging: function(evt, ui){ ... }
						}
					]
				});

  • rowSelectorClicked

    Cancellable:
    false

    Event fired after a row selector is clicked.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • row
          Type: jQuery

          Gets reference to the row the clicked row selector resides in.

        • fixedRow
          Type: jQuery

          Gets reference to the fixed row the clicked row selector resides in(if there are fixed columns).

        • rowIndex
          Type: Number

          Gets the index of the row the clicked row selector resides in.

        • rowKey
          Type: String

          Gets the key of the row the clicked row selector resides in.

        • rowSelector
          Type: jQuery

          Gets a reference to the row selector cell.

        • owner
          Type: Object

          Gets reference to RowSelectors.

        • grid
          Type: Object

          Gets a reference to the grid the RowSelectors are initialized for.

    Code Sample

     
				//Bind after initialization
				$(document).delegate(".selector", "iggridrowselectorsrowselectorclicked", function (evt, ui) {
					//return the triggered event
					evt;

					// reference to the row the clicked row selector resides in
					ui.row;

					// get the index of the row the clicked row selector resides in
					ui.rowIndex;

					// get the key of the row the clicked row selector resides in
					ui.rowKey;

					// get reference to the row selector cell
					ui.rowSelector;

					// get reference to the grid the RowSelectors are initialized for
					ui.grid;
				});

				//Initialize
				$(".selector").igGrid({
					features : [
						{
							name : "RowSelectors",
							rowSelectorClicked: function(evt, ui){ ... }
						}
					]
				});

  • changeLocale

    .igGridRowSelectors( "changeLocale" );

    Changes the all locales into the widget element to the language specified in options.language
    Note that this method is for rare scenarios, see language or locale option setter.

    Code Sample

     
				$(".selector").igGridRowSelectors("changeLocale");

  • destroy

    .igGridRowSelectors( "destroy" );

    Code Sample

     
			$(".selector").igGridRowSelectors("destroy");

  • ui-state-default ui-corner-all ui-igcheckbox-normal

    Classes applied to the checkbox container.

  • ui-icon ui-icon-check ui-igcheckbox-normal-off

    Classes defining the unchecked state of the checkbox.

  • ui-icon ui-icon-check ui-igcheckbox-normal-on

    Classes defining the checked state of the checkbox.

  • ui-iggrid-rowselector-footer

    Classes applied to the row selectors footer cells.

  • ui-iggrid-rowselector-header

    Classes applied to the row selectors header cells.

  • ui-state-hover

    Class defining the hover state style of the node.

  • ui-iggrid-rowselector-class

    Classes applied to the row selectors grid cells.

  • ui-iggrid-activecell ui-state-focus

    Classes applied to the row selectors grid cells when they are activated.

  • ui-iggrid-selectedcell ui-state-active

    Classes applied to the row selectors grid cells when they are selected.

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