Ignite UI™ API Documentation

ui.igTreeGridFiltering

Overview
Options
Events
Methods
Theming

The igTreeGrid features filtering that allows you to see the context of the matching rows. Filtering options include numeric, string and date filters and you can configure the display of results to show matches with or without child rows. 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 igTreeGrid 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 employees = [
                    { "employeeId": 0, "supervisorId": -1, "firstName": "Andrew", "lastName": "Fuller" },
                    { "employeeId": 1, "supervisorId": -1, "firstName": "Jonathan", "lastName": "Smith" },
                    { "employeeId": 2, "supervisorId": -1, "firstName": "Nancy", "lastName": "Davolio" },
                    { "employeeId": 3, "supervisorId": -1, "firstName": "Steven", "lastName": "Buchanan" },

                    // Andrew Fuller's direct reports
                    { "employeeId": 4, "supervisorId": 0, "firstName": "Janet", "lastName": "Leverling" },
                    { "employeeId": 5, "supervisorId": 0, "firstName": "Laura", "lastName": "Callahan" },
                    { "employeeId": 6, "supervisorId": 0, "firstName": "Margaret", "lastName": "Peacock" },
                    { "employeeId": 7, "supervisorId": 0, "firstName": "Michael", "lastName": "Suyama" },

                    // Janet Leverling's direct reports
                    { "employeeId": 8, "supervisorId": 4, "firstName": "Anne", "lastName": "Dodsworth" },
                    { "employeeId": 9, "supervisorId": 4, "firstName": "Danielle", "lastName": "Davis" },
                    { "employeeId": 10, "supervisorId": 4, "firstName": "Robert", "lastName": "King" },

                    // Nancy Davolio's direct reports
                    { "employeeId": 11, "supervisorId": 2, "firstName": "Peter", "lastName": "Lewis" },
                    { "employeeId": 12, "supervisorId": 2, "firstName": "Ryder", "lastName": "Zenaida" },
                    { "employeeId": 13, "supervisorId": 2, "firstName": "Wang", "lastName": "Mercedes" },

                    // Steve Buchanan's direct reports
                    { "employeeId": 14, "supervisorId": 3, "firstName": "Theodore", "lastName": "Zia" },
                    { "employeeId": 15, "supervisorId": 3, "firstName": "Lacota", "lastName": "Mufutau" },

                    // Lacota Mufutau's direct reports
                    { "employeeId": 16, "supervisorId": 15, "firstName": "Jin", "lastName": "Elliott" },
                    { "employeeId": 17, "supervisorId": 15, "firstName": "Armand", "lastName": "Ross" },
                    { "employeeId": 18, "supervisorId": 15, "firstName": "Dane", "lastName": "Rodriquez" },

                    // Dane Rodriquez's direct reports
                    { "employeeId": 19, "supervisorId": 18, "firstName": "Declan", "lastName": "Lester" },
                    { "employeeId": 20, "supervisorId": 18, "firstName": "Bernard", "lastName": "Jarvis" },

                    // Bernard Jarvis' direct report
                    { "employeeId": 21, "supervisorId": 20, "firstName": "Jeremy", "lastName": "Donaldson" }
                ];

               $(function () {
                   $("#treegrid").igTreeGrid({
                       dataSource: employees,
                       primaryKey: "employeeId",
                       foreignKey: "supervisorId",
                       autoGenerateColumns: false,
                       columns: [
                           { headerText: "ID", key: "employeeId", width: "150px", dataType: "number" },
                           { headerText: "First", key: "firstName", width: "150px", dataType: "string" },
                           { headerText: "Last", key: "lastName", width: "150px", dataType: "string" }
                       ],
                       features: [{
                           name: "Filtering",
                           displayMode: "showWithAncestors"
                           //displayMode: "showWithAncestorsAndDescendants"
                       }]
                   });
               });
            </script>
        </head>
        <body>
            <table id="treegrid"></table>
        </body>
        </html>

Related Samples

advancedModeEditorsVisible
Inherited

Type:: bool
Default:: false

Defines whether to render editors in advanced mode. If false, no editors will be rendered in the advanced mode.

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						advancedModeEditorsVisible : true
					}
				]
			});

			// Get
			var editorsVisible = $(".selector").igTreeGridFiltering("option", "advancedModeEditorsVisible");

			// Set
			$(".selector").igTreeGridFiltering("option", "advancedModeEditorsVisible", true);

advancedModeHeaderButtonLocation
Inherited

Type:: enumeration
Default:: left

Location of the advanced filtering button when advancedModeEditorsVisible is false (i.e. when the button is rendered in the header).

Members

left
Type:string
right
Type:string

Code Sample

 
				// Initialize
				$(".selector").igTreeGrid({
					features: [
						{
							name : "Filtering",
							advancedModeHeaderButtonLocation : "right"
						}
					]
				});
				// Get
				var location = $(".selector").igTreeGridFiltering("option", "advancedModeHeaderButtonLocation");
				// Set
				$(".selector").igTreeGridFiltering("option", "advancedModeHeaderButtonLocation", "right");

caseSensitive
Inherited

Type:: bool
Default:: false

Enables or disables the filtering case sensitivity. Works only for local filtering. If true, it case sensitive filtering is performed. If false, filtering is case insensitive.

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						caseSensitive : true
					}
				]
			});

			// Get
			var caseSensitive = $(".selector").igTreeGridFiltering("option", "caseSensitive");

			// Set
			$(".selector").igTreeGridFiltering("option", "caseSensitive", true);

columnSettings
Inherited

Type:: array
Default:: []
Elements Type:: object

A list of column settings that specifies custom filtering options on a per column basis.

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						columnSettings : [
							{
								columnKey: "ProductDescription", 
								condition: "endsWith"
							}
						]
					}
				]
			});

			// Get
			var colSettings = $(".selector").igTreeGridFiltering("option", "columnSettings");

			// Set
			$(".selector").igTreeGridFiltering("option", "columnSettings", 
				[{columnKey: "ProductDescription", 
					condition: "endsWith"
				}]
			);

allowFiltering

Type:: bool
Default:: true

Enables/disables filtering for the column.

Code Sample

 
					//Initialize
					$(".selector").igTreeGrid({
						features: [
							{
								name : "Filtering",
								columnSettings : [
									{
										columnKey: "ProductDescription", 
										allowFiltering: false
									}
								]
							}
						]
					});

					//Get
					var colSettings = $(".selector").igTreeGridFiltering("option", "columnSettings");
					var filterAllowed = colSettings[0].allowFiltering;

					// Set
					$(".selector").igTreeGridFiltering("option", "columnSettings", colSettings);

columnIndex

Type:: number
Default:: null

Identifies the grid column by index. Either key or index must be set in every column setting.

Code Sample

 
					// Initialize
					$(".selector").igTreeGrid({
						features: [
							{
								name : "Filtering",
								columnSettings : [
									{
										columnIndex: 0,
										allowFiltering: false
									}
								]
							}
						]
					});

					// Get
					var colSettings = $(".selector").igTreeGridFiltering("option", "columnSettings");
					var colIndex = colSettings[0].columnIndex;

columnKey

Type:: string
Default:: null

Identifies the grid column by key. Either key or index must be set in every column setting.

Code Sample

 
					//Initialize
					$(".selector").igTreeGrid({
						features: [
							{
								name : "Filtering",
								columnSettings : [
									{
										columnKey: "ProductDescription", 
										allowFiltering: false
									}
								]
							}
						]
					});

					//Get
					var colSettings = $(".selector").igTreeGridFiltering("option", "columnSettings");
					var colKey = colSettings[0].columnKey;

condition

Type:

enumeration

Default:

null
Initial filtering condition for the column.
Members
- empty
- Type:string
- notEmpty
- Type:string
- null
- Type:string
- notNull
- Type:string
- equals
- Type:string
- doesNotEqual
- Type:string
- startsWith
- Type:string
- contains
- Type:string
- doesNotContain
- Type:string
- endsWith
- Type:string
- greaterThan
- Type:string
- lessThan
- Type:string
- greaterThanOrEqualTo
- Type:string
- lessThanOrEqualTo
- Type:string
- true
- Type:bool
- false
- Type:bool
- on
- Type:string
- notOn
- Type:string
- before
- Type:string
- after
- Type:string
- today
- Type:string
- yesterday
- Type:string
- thisMonth
- Type:string
- lastMonth
- Type:string
- nextMonth
- Type:string
- thisYear
- Type:string
- nextYear
- Type:string
- lastYear
- Type:string
Code Sample
```
 
					// Initialize
					$(".selector").igTreeGrid({
						features: [
							{
								name : "Filtering",
								columnSettings : [
									{
										columnKey: "ProductDescription", 
										condition: "startsWith"
									}
								]
							}
						]
					});
					// Get
					var colSettings = $(".selector").igTreeGridFiltering("option", "columnSettings");
					var condition = colSettings[0].condition;
					// Set
					$(".selector").igTreeGridFiltering("option", "columnSettings", colSettings);
					 
```

conditionList

Type:: array
Default:: []
Elements Type:: object

An array of strings that determine which conditions to display for this column.

Code Sample

 
					//Initialize
					$(".selector").igTreeGrid({
						features: [
							{
								name : "Filtering",
								columnSettings : [{
									columnKey: "ProductNumber",
									conditionList: ["startsWith", "contains"]
								}]
							}
						]
					});

					//Get
					var conditionList = $(".selector").igTreeGridFiltering("option", "columnSettings")[2].conditionList;

customConditions

Type:: object
Default:: null

An object used to specify custom filtering conditions as objects for this column.

labelText The label as it will appear in the column's condition dropdown.
expressionText The text to display in the editor when requireExpr is false.
requireExpr If this condition requires the user to input a filtering expression.
filterImgIcon Class applied to the dropdown item when in simple mode.
filterFunc The custom comparing filter function. Signature: function (value, expression, dataType, ignoreCase, preciseDateFormat).

Code Sample

 
					// Initialize
					$(".selector").igTreeGrid({
						features: [
							{
								name : "Filtering",
								columnSettings : [{
									columnKey: "ProductNumber",
									customConditions: {
										BE: {
											labelText: "BE",
											expressionText: "BE-####",
											requireExpr: false,
											filterFunc: filterProductNumber
										},
										CA: {
											labelText: "CA",
											expressionText: "CA-####",
											requireExpr: false,
											filterFunc: filterProductNumber1
										}
									}
								}]
							}
						]
					});

					function filterProductNumber(value, expression, dataType, ignoreCase, preciseDateFormat) {
						return value.startsWith("BE");
					}

					function filterProductNumber1(value, expression, dataType, ignoreCase, preciseDateFormat) {
						return value.startsWith("CA");
					}
					// Get
					var customConditions = $(".selector").igTreeGridFiltering("option", "columnSettings")[2].customConditions;

defaultExpressions

Type:: object
Default:: []

Initial filtering expressions - if set they will be applied on initialization together with the preset condition.

Code Sample

 
					// Initialize
					$(".selector").igTreeGrid({
						features: [
							{
								name : "Filtering",
								columnSettings : [
									{
										columnKey: "Name", 
										defaultExpressions: [
											{ expr: "B", cond: "startsWith" }
										]
									}
								]
							}
						]
					});

					// Get
					var defaultExpressions = $(".selector").igTreeGridFiltering("option", "columnSettings")[0].defaultExpressions;

dialogWidget
Inherited

Type:: string
Default:: "igGridModalDialog"

Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog.

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						dialogWidget: "advancedModalDialog"
					}
				]
			});

			// Get
			var widgetName = $(".selector").igTreeGridFiltering("option", "dialogWidget");

displayMode

Type:

enumeration

Default:

showWithAncestors
If displayMode is showWithAncestorsAndDescendants, show all records that match filtering conditions and their child records, even if child records don"t match filtering conditions. If displayMode is showWithAncestors show only those records that match filtering conditions and do not show child records(if any) that don"t match filtering conditions.
Code Sample
```
 
					$(".selector").igTreeGrid({
						features: [
							{
								name : "Filtering",
								displayMode : "showWithAncestorsAndDescendants"
							}
						]
					});
					//Get
					var displayMode = $(".selector").igTreeGridFiltering("option", "displayMode");
				 
```

featureChooserText
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Feature chooser text when filter is shown and filter mode is simple. Use option locale.featureChooserText.

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						featureChooserText : "Hide Filter"
					}
				]
			});

			// Get
			var text = $(".selector").igTreeGridFiltering("option", "featureChooserText");

			// Set
			$(".selector").igTreeGridFiltering("option", "featureChooserText", "Hide Filter");

featureChooserTextAdvancedFilter
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Feature chooser text when filter mode is advanced. Use option locale.featureChooserTextAdvancedFilter.

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						featureChooserTextAdvancedFilter : "Advanced Filter"
					}
				]
			});

			// Get
			var text = $(".selector").igTreeGridFiltering("option", "featureChooserTextAdvancedFilter");

			// Set
			$(".selector").igTreeGridFiltering("option", "featureChooserTextAdvancedFilter", "Advanced Filter");

featureChooserTextHide
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Feature chooser text when filter is hidden and filter mode is simple. Use option locale.featureChooserTextHide.

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						featureChooserTextHide : "Show Filter"
					}
				]
			});

			// Get
			var text = $(".selector").igTreeGridFiltering("option", "featureChooserTextHide");

			// Set
			$(".selector").igTreeGridFiltering("option", "featureChooserTextHide", "Show Filter");

filterButtonLocation
Inherited

Type:: enumeration
Default:: left

The filtering button for filter dropdowns can be rendered either on the left of the filter editor, or on the right.

Members

left
Type:string
The button is rendered on the left.
right
Type:string
The button is rendered on the right.

Code Sample

 
				// Initialize
				$(".selector").igTreeGrid({
					features: [
						{
							name : "Filtering",
							filterButtonLocation : "right"
						}
					]
				});
				// Get
				var location = $(".selector").igTreeGridFiltering("option", "filterButtonLocation");
				// Set
				$(".selector").igTreeGridFiltering("option", "filterButtonLocation", "right");

filterDelay
Inherited

Type:: number
Default:: 500

Time in milliseconds for which widget will wait between keystrokes before sending filtering requests.

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						filterDelay : 1000
					}
				]
			});

			// Get
			var delay = $(".selector").igTreeGridFiltering("option", "filterDelay");

			// Set
			$(".selector").igTreeGridFiltering("option", "filterDelay", 1000);

filterDialogAddButtonWidth
Inherited

Type:: enumeration
Default:: 100

Add button width - in the advanced filter dialog.

Members

string
Type:string
The dialog Add button width in pixels (100px).
number
Type:number
The dialog Add button width in pixels as a number (100).

Code Sample

 
				// Initialize
				$(".selector").igTreeGrid({
					features: [
						{
							name : "Filtering",
							filterDialogAddButtonWidth : 75
						}
					]
				});
				// Get
				var width = $(".selector").igTreeGridFiltering("option", "filterDialogAddButtonWidth");
				// Set
				$(".selector").igTreeGridFiltering("option", "filterDialogAddButtonWidth", 75);

filterDialogAddConditionDropDownTemplate
Inherited

Type:: string
Default:: null

Custom template for options in dropdown in add condition area in the filter dialog. The default template is "<option value='${value}'>${text}</option>".

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						filterDialogAddConditionDropDownTemplate: "<option value='${text}'>${text}</option>"
					}
				]
			});

			// Get
			var dropDownTemplate = $(".selector").igTreeGridFiltering("option", "filterDialogAddConditionDropDownTemplate");

			// Set
			$(".selector").igTreeGridFiltering("option",
										   "filterDialogAddConditionDropDownTemplate",
										   "<option value='${text}'>${text}</option>");

filterDialogAddConditionTemplate
Inherited

Type:: string
Default:: null

Custom template for add condition area in the filter dialog. The default template is "<div><span>${label1}</span><div><select></select></div><span>${label2}</span></div>".

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						filterDialogAddConditionTemplate: "<div><div><select></select></div><span>${label1}</span><span>${label2}</span></div>"
					}
				]
			});

			// Get
			var addConditionTemplate = $(".selector").igTreeGridFiltering("option", "filterDialogAddConditionTemplate");

			// Set
			$(".selector").igTreeGridFiltering("option",
										   "filterDialogAddConditionTemplate",
										   "<div><div><select></select></div><span>${label1}</span><span>${label2}</span></div>");

filterDialogColumnDropDownDefaultWidth
Inherited

Type:: enumeration
Default:: null

Width of the column chooser dropdowns in the advanced filter dialog.

Members

string
Type:string
The column chooser dropdowns width in pixels (80px).
number
Type:number
The column chooser dropdowns width in pixels as a number (80).

Code Sample

 
				// Initialize
				$(".selector").igTreeGrid({
					features: [
						{
							name : "Filtering",
							filterDialogColumnDropDownDefaultWidth : 100
					    }
					]
				});
				// Get
				var width = $(".selector").igTreeGridFiltering("option", "filterDialogColumnDropDownDefaultWidth");
				// Set
				$(".selector").igTreeGridFiltering("option", "filterDialogColumnDropDownDefaultWidth", 100);

filterDialogContainment
Inherited

Type:: string
Default:: "owner"

Controls containment behavior.

owner The filter dialog will be draggable only within the grid area.
window The filter dialog will be draggable within the whole window area.

Code Sample

 
				// Initialize
				$(".selector").igTreeGrid({
					features: [
						{
							name : "Filtering",
							filterDialogContainment : "window"
					    }
					]
				});

				// Get
				var filterDialogContainment = $(".selector").igTreeGridFiltering("option", "filterDialogContainment");

filterDialogExprInputDefaultWidth
Inherited

Type:: enumeration
Default:: 130

Width of the filtering expression input boxes in the advanced filter dialog.

Members

string
Type:string
The filtering expression input boxes width in pixels (80px).
number
Type:number
The filtering expression input boxes width in pixels as a number (80).

Code Sample

 
				// Initialize
				$(".selector").igTreeGrid({
					features: [
						{
							name : "Filtering",
							filterDialogExprInputDefaultWidth : 100
					    }
					]
				});
				// Get
				var width = $(".selector").igTreeGridFiltering("option", "filterDialogExprInputDefaultWidth");
				// Set
				$(".selector").igTreeGridFiltering("option", "filterDialogExprInputDefaultWidth", 100);

filterDialogFilterConditionTemplate
Inherited

Type:: string
Default:: null

Custom template for options in condition list in filter dialog. The default template is "<option value='${condition}'>${text}</option>".

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						filterDialogFilterConditionTemplate: "<option value='${conditionName}'>${conditionLabel}</option>"
					}
				]
			});

			// Get
			var filterConditionTemplate = $(".selector").igTreeGridFiltering("option", "filterDialogFilterConditionTemplate");

			// Set
			$(".selector").igTreeGridFiltering("option",
										   "filterDialogFilterConditionTemplate",
										   "<option value='${conditionName}'>${conditionLabel}</option>");

filterDialogFilterDropDownDefaultWidth
Inherited

Type:: enumeration
Default:: 80

Width of the filtering condition dropdowns in the advanced filter dialog.

Members

string
Type:string
The filtering condition dropdowns width in pixels (80px).
number
Type:number
The filtering condition dropdowns width in pixels as a number (80).

Code Sample

 
				// Initialize
				$(".selector").igTreeGrid({
					features: [
						{
							name : "Filtering",
							filterDialogFilterDropDownDefaultWidth : 100
						}
					]
				});
				// Get
				var width = $(".selector").igTreeGridFiltering("option", "filterDialogFilterDropDownDefaultWidth");
				// Set
				$(".selector").igTreeGridFiltering("option", "filterDialogFilterDropDownDefaultWidth", 100);

filterDialogFilterTemplate
Inherited

Type:: string
Default:: null

Custom template for filter dialog.
Each DOM element which is used for selecting filter conditions/columns/filter expressions has "data-*" attribute.
E.g.: DOM element used for selecting column has attribute "data-af-col", for selecting filter condition - "data-af-cond", for filter expression- "data-af-expr".
NOTE: The template is supported only with <tr />.
The default template is "<tr data-af-row><td><input data-af-col/></td><td><select data-af-cond></select></td><td><input data-af-expr /> </td><td><span data-af-rmv></span></td></tr>".

Code Sample

 
				// Initialize
				$(".selector").igTreeGrid({
					features: [
						{
							name : "Filtering",
							filterDialogFilterTemplate: "<tr><td>Choose column<input/></td><td>Condition<select></select></td><td>Search value<input /> </td><td><span></span></td></tr>"
						}
					]
				});

				// Get
				var dialogFilterTemplate = $(".selector").igTreeGridFiltering("option", "filterDialogFilterTemplate");

				// Set
				$(".selector").igTreeGridFiltering("option",
											   "filterDialogFilterTemplate",
											   "<tr><td>Choose column<input/></td><td>Condition<select></select></td><td>Search value<input /> </td><td><span></span></td></tr>");

filterDialogHeight
Inherited

Type:: enumeration
Default:: ""

default filter dialog height (used for Advanced filtering mode).

Members

string
Type:string
The dialog window height in pixels (350px).
number
Type:number
The dialog window height in pixels as a number (350).

Code Sample

 
				// Initialize
				$(".selector").igTreeGrid({
					features: [
						{
							name : "Filtering",
							filterDialogHeight : 30
						}
					]
				});
				// Get
				var height = $(".selector").igTreeGridFiltering("option", "filterDialogHeight");
				// Set
				$(".selector").igTreeGridFiltering("option", "filterDialogHeight", 30);

filterDialogMaxFilterCount
Inherited

Type:: number
Default:: 5

Maximum number of filter rows in the advanced filtering dialog. If this number is exceeded, an error message will be rendered.

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						filterDialogMaxFilterCount : 3
					}
				]
			});

			// Get
			var count = $(".selector").igTreeGridFiltering("option", "filterDialogMaxFilterCount");

			// Set
			$(".selector").igTreeGridFiltering("option", "filterDialogMaxFilterCount", 3);

filterDialogOkCancelButtonWidth
Inherited

Type:: enumeration
Default:: 120

Width of the Ok and Cancel buttons in the advanced filtering dialogs.

Members

string
Type:string
The advanced filter dialog Ok and Cancel buttons width in pixels (120px).
number
Type:number
The advanced filter dialog Ok and Cancel buttons width in pixels as a number (120).

Code Sample

 
				// Initialize
				$(".selector").igTreeGrid({
					features: [
						{
							name : "Filtering",
							filterDialogOkCancelButtonWidth : 120
						}
					]
				});
				// Get
				var width = $(".selector").igTreeGridFiltering("option", "filterDialogOkCancelButtonWidth");
				// Set
				$(".selector").igTreeGridFiltering("option", "filterDialogOkCancelButtonWidth", 120);

filterDialogWidth
Inherited

Type:: enumeration
Default:: 430

Default filter dialog width (used for Advanced filtering mode).

Members

string
Type:string
The dialog window width in pixels (370px).
number
Type:number
The dialog window width in pixels as a number (370).

Code Sample

 
				// Initialize
				$(".selector").igTreeGrid({
					features: [
						{
							name : "Filtering",
							filterDialogWidth : 500
						}
					]
				});
				// Get
				var width = $(".selector").igTreeGridFiltering("option", "filterDialogWidth");
				// Set
				$(".selector").igTreeGridFiltering("option", "filterDialogWidth", 500);

filterDropDownAnimationDuration
Inherited

Type:: number
Default:: 500

Animation duration in milliseconds for the filterDropDownAnimations.

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						filterDropDownAnimationDuration : 300
					}
				]
			});

			// Get
			var duration = $(".selector").igTreeGridFiltering("option", "filterDropDownAnimationDuration");

			// Set
			$(".selector").igTreeGridFiltering("option", "filterDropDownAnimationDuration", 300);

filterDropDownAnimations
Inherited

Type:: enumeration
Default:: linear

Type of animations for the column filter dropdowns.

Members

linear
Type:string
The column filtering drop downs are shown with a linear animation.
none
Type:string
No animation is used when showing the filtering drop downs.

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						filterDropDownAnimations : "none"
					}
				]
			});
			// Get
			var animation = $(".selector").igTreeGridFiltering("option", "filterDropDownAnimations");
			// Set
			$(".selector").igTreeGridFiltering("option", "filterDropDownAnimations", "none");

filterDropDownHeight
Inherited

Type:: object
Default:: 0

Height of the column filter dropdowns.

string The height of the column filter dropdowns in pixels (0px).
number The height of the column filter dropdowns in pixels as a number (0).

Code Sample

 
				// Initialize
				$(".selector").igTreeGrid({
					features: [
						{
							name : "Filtering",
							filterDropDownHeight : 30
						}
					]
				});

				// Get
				var height = $(".selector").igTreeGridFiltering("option", "filterDropDownHeight");

				// Set
				$(".selector").igTreeGridFiltering("option", "filterDropDownHeight", 30);

filterDropDownItemIcons
Inherited

Type:: enumeration
Default:: true

Enable/disable filter icons visibility.

Members

true
Type:bool
All predefined filters in the filter dropdowns will have icons rendered in front of the text.
false
Type:bool
No icons will be rendered.

Code Sample

 
				// Initialize
				$(".selector").igTreeGrid({
					features: [
						{
							name : "Filtering",
							filterDropDownItemIcons : false
						}
					]
				});
				// Get
				var showIcons = $(".selector").igTreeGridFiltering("option", "filterDropDownItemIcons");
				// Set
				$(".selector").igTreeGridFiltering("option", "filterDropDownItemIcons", false);

filterDropDownWidth
Inherited

Type:: enumeration
Default:: 0

Width of the column filter dropdowns.

Members

string
Type:string
The width in pixels (0px).
number
Type:number
The width in pixels as a number (0).

Code Sample

 
				// Initialize
				$(".selector").igTreeGrid({
					features: [
						{
							name : "Filtering",
							filterDropDownWidth : 100
						}
					]
				});
				// Get
				var width = $(".selector").igTreeGridFiltering("option", "filterDropDownWidth");
				// Set
				$(".selector").igTreeGridFiltering("option", "filterDropDownWidth", 100);

filterExprUrlKey
Inherited

Type:: string
Default:: null

URL key name that specifies how the filtering expressions will be encoded for remote requests, e.g. &filter('col') = startsWith. Default is OData.

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						filterExprUrlKey : "filter"
					}
				]
			});

			// Get
			var key = $(".selector").igTreeGridFiltering("option", "filterExprUrlKey");

			// Set
			$(".selector").igTreeGridFiltering("option", "filterExprUrlKey", "filter");

filterSummaryAlwaysVisible
Inherited

Type:

bool

Default:

true
Enable/disable footer visibility with summary info about the filter.
When false, the filter summary row (in the footer) will only be visible when paging is enabled (or some other feature that renders a footer).
When true, the filter summary row will only be visible when a filter is applied i.e. it's not visible by default.
Code Sample
```
 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						filterSummaryAlwaysVisible : false
					}
				]
			});

			// Get
			var showSummary = $(".selector").igTreeGridFiltering("option", "filterSummaryAlwaysVisible");

			// Set
			$(".selector").igTreeGridFiltering("option", "filterSummaryAlwaysVisible", false);
			 
```
filterSummaryInPagerTemplate
Removed

Type:

string

Default:

null
This option has been removed as of 2017.2 Volume release.
Template that is used when filtering is applied and paging is enabled and user goes to another page. It takes precedence over the pagerRecordsLabelTemplate(option from igTreeGridPaging). If it is set to null then it is taken option from igTreeGridPaging.
Supported options:
${currentPageMatches} (filtering)
${totalMatches} (filtering)
${startRecord} (paging)
${endRecord} (paging)
${recordCount} (paging)
Use option locale.collapseTooltipText.
Code Sample
```
        //Initialize
        $(".selector").igTreeGrid({
            features: [
                {
                    name : "Filtering",
                    filterSummaryInPagerTemplate : "${startRecord} - ${endRecord} of ${recordCount} records"
                }
            ]
        });

        //Get
        var filterPagerSummary = $(".selector").igTreeGridFiltering("option", "filterSummaryInPagerTemplate");
      
```

filterSummaryTemplate
Removed

Type:: string
Default:: ""

This option has been removed as of 2017.2 Volume release.
Summary template that will appear in the bottom left corner of the footer. Has the format '${matches} matching records'. Use option locale.filterSummaryTemplate.

Code Sample

 
			// Initialize
			$(".selector").igTreeGrid({
				features: [
					{
						name : "Filtering",
						filterSummaryTemplate: "${matches} products found"
					}
				]
			});

			// Get
			var summaryTemplate = $(".selector").igTreeGridFiltering("option", "filterSummaryTemplate");

			// Set
			$(".selector").igTreeGridFiltering("option", "filterSummaryTemplate", "${matches} products");

fromLevel

Type:: number
Default:: 0

Specifies from which data bound level to be applied filtering - 0 is the first level.

Code Sample

 
					$(".selector").igTreeGrid({
						features: [
							{
								name : "Filtering",
									fromLevel: 1
							}
						]
					});

					//Get
					var fromLevel = $(".selector").igTreeGridFiltering("option", "fromLevel");

labels
Removed

Type:: string
Default:: "{}"

This option has been removed as of 2017.2 Volume release.
A list of configurable and localized labels that are used for the predefined filtering conditions in the filter dropdowns. Use option locale.