ui.igTreeGridColumnFixing
The igTreeGrid includes column fixing which allows you to pin the columns on the left or the right of the grid so that they are always visible. Further information regarding the classes, options, events, methods and themes of this API are available under the associated tabs above.
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: "ColumnFixing" } ] }); }); </script> </head> <body> <table id="treegrid"></table> </body> </html>
Related Topics
Dependencies
Inherits
-
columnSettings
Inherited- Type:
- array
- Default:
- []
- Elements Type:
- object
List of column settings that specifies custom column fixing options on a per column basis.
Code Sample
//Initialize $(".selector").igTreeGrid({ features : [ { name : "ColumnFixing", columnSettings: [ { columnKey: "Name", allowFixing: false, isFixed: true } ] } ] }); //Get var columnSettings = $(".selector").igTreeGridColumnFixing("option", "columnSettings");
-
allowFixing
- Type:
- bool
- Default:
- true
Specifies whether the column can be fixed or not. If allow fixing is false, then the fixing pin will not be rendered for the column.
Code Sample
//Initialize $(".selector").igTreeGrid({ features : [ { name : "ColumnFixing", columnSettings: [ { columnKey: "Name", allowFixing: false, isFixed: true } ] } ] }); //Get var columnSettings = $(".selector").igTreeGridColumnFixing("option", "columnSettings");
-
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 : "ColumnFixing", columnSettings: [ { columnIndex: 2, allowFixing: false, isFixed: true } ] } ] }); //Get var columnSettings = $(".selector").igTreeGridColumnFixing("option", "columnSettings");
-
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 : "ColumnFixing", columnSettings: [ { columnKey: "Name", allowFixing: false, isFixed: true } ] } ] }); //Get var columnSettings = $(".selector").igTreeGridColumnFixing("option", "columnSettings");
-
isFixed
- Type:
- bool
- Default:
- false
Specifies whether the column is initially fixed or not. Check this topic out for more information.
Code Sample
//Initialize $(".selector").igTreeGrid({ features : [ { name : "ColumnFixing", columnSettings: [ { columnKey: "Name", allowFixing: false, isFixed: true } ] } ] }); //Get var columnSettings = $(".selector").igTreeGridColumnFixing("option", "columnSettings");
-
featureChooserTextFixedColumn
Inherited- Type:
- string
- Default:
- ""
Text of the feature chooser button for fixing a currently unfixed column.
Code Sample
//Initialize $(".selector").igTreeGrid({ features : [ { name : "ColumnFixing", featureChooserTextFixedColumn: "Fix column" } ] }); //Get var featureChooserTextFixedColumn = $(".selector").igTreeGridColumnFixing("option", "featureChooserTextFixedColumn");
-
featureChooserTextUnfixedColumn
Inherited- Type:
- string
- Default:
- ""
Text of the feature chooser button for unfixing a currently fixed column.
Code Sample
//Initialize $(".selector").igTreeGrid({ features : [ { name : "ColumnFixing", featureChooserTextUnfixedColumn: "Unfix column" } ] }); //Get var featureChooserTextUnfixedColumn = $(".selector").igTreeGridColumnFixing("option", "featureChooserTextUnfixedColumn");
-
fixingDirection
Inherited- Type:
- enumeration
- Default:
- left
Configures which side the fixed columns of the grid will be rendered on. Check this topic out of more information.
Members
- left
- Type:string
- Fixed columns are rendered on the left side of the main grid.
- right
- Type:string
- Fixed columns are rendered on the right side of the main grid.
Code Sample
//Initialize $(".selector").igTreeGrid({ features : [ { name : "ColumnFixing", fixingDirection: "right" } ] }); //Get var fixingDirection = $(".selector").igTreeGridColumnFixing("option", "fixingDirection");
-
fixNondataColumns
Inherited- Type:
- bool
- Default:
- true
Specify initial fixing of all non data columns. Non-data columns are columns in the grid rendered for specific features, like the row selectors feature. The column containing the row numbering is such a column. This option is applicable when fixingDirection is set to left. For a full column fixing configuration summary please refer to this topic.
Code Sample
//Initialize $(".selector").igTreeGrid({ features : [ { name : "ColumnFixing", fixNondataColumns: true } ] }); //Get var fixNondataColumns = $(".selector").igTreeGridColumnFixing("option", "fixNondataColumns");
-
headerFixButtonText
Inherited- Type:
- string
- Default:
- ""
Specifies the tooltip text on the column fixing header icon when column is not fixed.
Code Sample
//Initialize $(".selector").igTreeGrid({ features : [ { name : "ColumnFixing", headerFixButtonText: "Click to fix this column" } ] }); //Get var headerFixButtonText = $(".selector").igTreeGridColumnFixing("option", "headerFixButtonText");
-
headerUnfixButtonText
Inherited- Type:
- string
- Default:
- ""
Specifies the tooltip text on the column fixing header icon when column is fixed.
Code Sample
//Initialize $(".selector").igTreeGrid({ features : [ { name : "ColumnFixing", headerUnfixButtonText: "Click to unfix this column" } ] }); //Get var headerUnfixButtonText = $(".selector").igTreeGridColumnFixing("option", "headerUnfixButtonText");
-
minimalVisibleAreaWidth
Inherited- Type:
- enumeration
- Default:
- 30
Minimal visible area in pixels for the unfixed columns. If the end user tries to fix a column(or columns), which causes the width of the fixed columns to grow such that the width of visible area of unfixed columns is less than this option then fixing will be canceled. Check this topic out for more information.
Members
- string
- Type:string
- The width can be set in pixels (px) and percentage (%).
- number
- Type:number
- The width can be set in pixels as a number.
Code Sample
//Initialize $(".selector").igTreeGrid({ features : [ { name : "ColumnFixing", minimalVisibleAreaWidth: 100 } ] }); //Get var minimalVisibleAreaWidth = $(".selector").igTreeGridColumnFixing("option", "minimalVisibleAreaWidth");
-
populateDataRowsAttributes
Deprecated- Type:
- bool
- Default:
- true
When true all the TR DOM attributes of the unfixed row will be copied to the fixed row. Note that when enabled this option negatively affects performance when fixing a column.
Code Sample
//Initialize $(".selector").igTreeGrid({ features : [ { name : "ColumnFixing", populateDataRowsAttributes: false } ] }); //Get var populateDataRowsAttributes = $(".selector").igTreeGridColumnFixing("option", "populateDataRowsAttributes");
-
scrollDelta
Inherited- Type:
- number
- Default:
- 40
Scroll delta in pixels when scrolling with the mouse wheel or the keyboard in the fixed columns area of the grid.
Code Sample
//Initialize $(".selector").igTreeGrid({ features : [ { name : "ColumnFixing", scrollDelta: 100 } ] }); //Get var scrollDelta = $(".selector").igTreeGridColumnFixing("option", "scrollDelta");
-
showFixButtons
Inherited- Type:
- bool
- Default:
- true
Specifies whether to show the column fixing buttons in header cells/feature chooser.
Code Sample
//Initialize $(".selector").igTreeGrid({ features : [ { name : "ColumnFixing", showFixButtons: false } ] }); //Get var showFixButtons = $(".selector").igTreeGridColumnFixing("option", "showFixButtons");
-
syncRowHeights
Inherited- Type:
- bool
- Default:
- true
Enable row height sync for the fixed and unfixed portion of the grid. If you're observing row misalignment, please refer to this article.
Code Sample
//Initialize $(".selector").igTreeGrid({ features : [ { name : "ColumnFixing", syncRowHeights: true } ] }); //Get var syncRowHeights = $(".selector").igTreeGridColumnFixing("option", "syncRowHeights");
For more information on how to interact with the Ignite UI controls' events, refer to
Using Events in Ignite UI.
-
columnFixed
Inherited- Cancellable:
- false
Event which is fired when column fixing operation is finished.
Code Sample
//Bind after initialization $(document).delegate(".selector", "igtreegridcolumnfixingcolumnfixed", function (evt, args) { //Get the column key of the fixed column args.columnKey //Get the column index of the fixed column args.columnIndex //Get a reference to the widget args.owner }); //Initialize $(".selector").igTreeGrid({ features: [ { name: "ColumnFixing", columnFixed: function (evt, args) { ... } } ] });
-
columnFixing
Inherited- Cancellable:
- true
Event which is fired when column fixing operation is initiated.
Code Sample
//Bind after initialization $(document).delegate(".selector", "igtreegridcolumnfixingcolumnfixing", function (evt, args) { //Get the column key of the fixed column args.columnKey //Get the column index of the fixed column args.columnIndex //Get a reference to the widget args.owner }); //Initialize $(".selector").igTreeGrid({ features: [ { name: "ColumnFixing", columnFixing: function (evt, args) { ... } } ] });
-
columnFixingRefused
Inherited- Cancellable:
- false
Event which is fired when column fixing operation has failed - e.g. sum of the width of the fixed columns container and width of the column to be fixed exceeds the grid width.
-
evtType: Event
JQuery event object.
-
argsType: Object
-
columnIdentifierType: Object
Gets the columnKey or the columnIndex.
-
isGroupHeaderType: Bool
Gets whether header cell has children(use this argument ONLY when multi-column-headers are enabled).
-
errorMessageType: String
Gets the error message describing the reason fixing has failed.
-
ownerType: Object
Gets a reference to the widget.
-
Code Sample
//Bind after initialization $(document).delegate(".selector", "igtreegridcolumnfixingcolumnfixingrefused", function (evt, args) { //Get the column key of the column to be fixed args.columnKey //Get whether header cell is of type multi-column (when multi-column headers are defined) args.isGroupHeader //Get error message describing the reason fixing has failed args.errorMessage //Get a reference to the widget args.owner }); //Initialize $(".selector").igTreeGrid({ features: [ { name: "ColumnFixing", columnFixingRefused: function (evt, args) { ... } } ] });
-
columnUnfixed
Inherited- Cancellable:
- false
Event which is fired when column unfixing operation is done.
Code Sample
//Bind after initialization $(document).delegate(".selector", "igtreegridcolumnfixingcolumnunfixed", function (evt, args) { //Get the column key of the column to be fixed args.columnKey //Get the column index of the unfixed column args.columnIndex //Get a reference to the widget args.owner }); //Initialize $(".selector").igTreeGrid({ features: [ { name: "ColumnFixing", columnUnfixed: function (evt, args) { ... } } ] });
-
columnUnfixing
Inherited- Cancellable:
- true
Event which is fired when column unfixing operation is initiated.
Code Sample
//Bind after initialization $(document).delegate(".selector", "igtreegridcolumnfixingcolumnunfixing", function (evt, args) { //Get the column key of the column to be fixed args.columnKey //Get the column index of the unfixed column args.columnIndex //Get a reference to the widget args.owner }); //Initialize $(".selector").igTreeGrid({ features: [ { name: "ColumnFixing", columnUnfixing: function (evt, args) { ... } } ] });
-
columnUnfixingRefused
Inherited- Cancellable:
- false
Event which is fired when column unfixing operation has failed - e.g.: there is only one fixed visible column(and tries to unfix it) and at least one fixed hidden column.
-
evtType: Event
JQuery event object.
-
argsType: Object
-
columnIdentifierType: Object
Gets the columnKey or the columnIndex.
-
isGroupHeaderType: Bool
Gets whether header cell has children(use this argument ONLY when multi-column-headers are enabled).
-
errorMessageType: String
Gets the error message describing the reason fixing has failed.
-
ownerType: Object
Gets a reference to the widget.
-
Code Sample
//Bind after initialization $(document).delegate(".selector", "igtreegridcolumnfixingcolumnunfixingrefused", function (evt, args) { //Get a reference to the grid widget args.owner //Get the columnKey or columnIndex args.columnIdentifier //Get whether header cell has children args.isGroupHeader //Get error message describing the reason unfixing has failed args.errorMessage }); //Initialize $(".selector").igTreeGrid({ features: [ { name: "ColumnFixing", columnUnfixingRefused: function (evt, args) { ... } } ] });
-
checkAndSyncHeights
Inherited- .igTreeGridColumnFixing( "checkAndSyncHeights" );
Checks whether the heights of fixed and unfixed tables are equal - if not sync them. Similar check is made for heights of table rows.
Code Sample
$(".selector").igTreeGridColumnFixing("checkAndSyncHeights");
-
checkFixingAllowed
Inherited- .igTreeGridColumnFixing( "checkFixingAllowed", columns:array );
- Return Type:
- bool
- Return Type Description:
- Returns whether column fixing can be performed for the specified columns.
Checks whether column fixing is allowed for the specified columns. It should not be allowed if there is only one visible column in the unfixed area.
- columns
- Type:array
- Array of columns and/or column identifiers - could be column indexes, column keys, column object or mixed.
Code Sample
$(".selector").igTreeGridColumnFixing("checkFixingAllowed", columns[0]);
-
checkUnfixingAllowed
Inherited- .igTreeGridColumnFixing( "checkUnfixingAllowed", columns:array );
- Return Type:
- bool
- Return Type Description:
- Returns whether column unfixing can be performed for the specified columns.
Checks whether unfixing is allowed for the specified columns. It should not be allowed if there is only one visible column in the fixed area.
- columns
- Type:array
- Array of columns and/or column identifiers - could be column indexes, column keys, column object or mixed.
Code Sample
$(".selector").igTreeGridColumnFixing("checkUnfixingAllowed", columns[0]);
-
destroy
- .igTreeGridColumnFixing( "destroy" );
Code Sample
$(".selector").igTreeGridColumnFixing("destroy");
-
fixColumn
Inherited- .igTreeGridColumnFixing( "fixColumn", colIdentifier:object, [target:string], [after:bool] );
- Return Type:
- object
- Return Type Description:
- Object description: { result: indicates whether fixing is successful, error: error message describing the reason fixing has failed, col: reference to the column object(if column identifier is not valid - then its value is null) }.
Fixes a column by specified column identifier - column index or column key.
- colIdentifier
- Type:object
- An identifier of the column to be fixed - column index or column key.
- target
- Type:string
- Optional
- Key of the column where the fixed column should move to.
- after
- Type:bool
- Optional
- Specifies where the fixed column should be moved after or before the target column. This parameter is disregarded if there is no target column specified.
Code Sample
$(".selector").igTreeGridColumnFixing("fixColumn", "Name", false);
-
fixDataSkippedColumns
Deprecated- .igTreeGridColumnFixing( "fixDataSkippedColumns" );
This function is deprecated - use function fixNonDataColumns.
-
fixNonDataColumns
Inherited- .igTreeGridColumnFixing( "fixNonDataColumns" );
Fixes non-data columns (such as the row numbering column of row selectors) if any and if fixingDirection is left. Does nothing if the non-data columns are already fixed.
Code Sample
$(".selector").igTreeGridColumnFixing("fixNonDataColumns");
-
getWidthOfFixedColumns
Inherited- .igTreeGridColumnFixing( "getWidthOfFixedColumns", [fCols:array], [excludeNonDataColumns:bool], [includeHidden:bool] );
- Return Type:
- number
- Return Type Description:
- Returns the total width of the columns.
Calculates widths of the fixed columns.
- fCols
- Type:array
- Optional
- Array of grid columns. If not set then the total width of the fixed columns are returned.
- excludeNonDataColumns
- Type:bool
- Optional
- If set to true do not calculate the width of non-data fixed columns (like the row selector row numbering column).
- includeHidden
- Type:bool
- Optional
- If set to true calculates width of the hidden fixed columns (their initial width before hiding).
Code Sample
$(".selector").igTreeGridColumnFixing("getWidthOfFixedColumns", [$(".selector").igTreeGrid("option", "columns")[1]], true, false);
-
isGroupHeader
Inherited- .igTreeGridColumnFixing( "isGroupHeader", colKey:string );
- Return Type:
- bool
- Return Type Description:
- Returns whether the column is a group header.
Returns whether the column with the specified key is a column group header, when the multi-column headers feature is used.
- colKey
- Type:string
- The key of the column to perform the check for.
Code Sample
$(".selector").igTreeGridColumnFixing("isGroupHeader", "Name");
-
syncHeights
Inherited- .igTreeGridColumnFixing( "syncHeights", [check:bool], [clearRowsHeights:bool] );
If the 'check' argument is set to true, checks whether the heights of fixed and unfixed tables are equal, if not sync them. Similar check is made for heights of table rows. If the clearRowsHeights argument is set to true, clears rows heights before syncing them.
- check
- Type:bool
- Optional
- If set to true, checks whether the heights of fixed and unfixed tables are equal, if not sync them. If this argument is set to false sync is performed regardless of the current heights.
- clearRowsHeights
- Type:bool
- Optional
- Clears row heigths for all visible rows.
Code Sample
$(".selector").igTreeGridColumnFixing("syncHeights", true, true);
-
syncRowsHeights
Inherited- .igTreeGridColumnFixing( "syncRowsHeights", $trs:array, $anotherRows:array );
Syncs rows heights between two collections of rows.
- $trs
- Type:array
- An array of rows of the first(fixed/unfixed) container.
- $anotherRows
- Type:array
- An array of rows of the second(fixed/unfixed) container.
Code Sample
var $fixedRows = $(".selector").igTreeGrid("fixedRows"); var $unfixedRows = $(".selector").igTreeGrid("rows"); $(".selector").igTreeGridColumnFixing("syncRowsHeights", $fixedRows, $unfixedRows);
-
unfixAllColumns
Inherited- .igTreeGridColumnFixing( "unfixAllColumns" );
Unfixes all fixed columns.
Code Sample
$(".selector").igTreeGridColumnFixing("unfixAllColumns");
-
unfixColumn
Inherited- .igTreeGridColumnFixing( "unfixColumn", colIdentifier:object, [target:string], [after:bool] );
- Return Type:
- object
- Return Type Description:
- Object description: { result: indicates whether unfixing is successful, error: error message describing the reason unfixing has failed, col: reference to the column object(if column identifier is not valid - then its value is null) }.
Unfixes a column by specified column identifier - column key or column index.
- colIdentifier
- Type:object
- An identifier of the column to be unfixed - column index or column key.
- target
- Type:string
- Optional
- Key of the column where the unfixed column should move to.
- after
- Type:bool
- Optional
- Specifies where the unfixed column should be rendered after or before the target column. This parameter is disregarded if there is no target column specified.
Code Sample
$(".selector").igTreeGridColumnFixing("unfixColumn", "Name", false);
-
unfixDataSkippedColumns
Deprecated- .igTreeGridColumnFixing( "unfixDataSkippedColumns" );
This function is deprecated - use function unfixNonDataColumns.
-
unfixNonDataColumns
Inherited- .igTreeGridColumnFixing( "unfixNonDataColumns" );
Unfixes non-data columns (such as the row numbering column of row selectors) if any and if fixingDirection is left. Does nothing if the non-data columns are already fixed.
Code Sample
$(".selector").igTreeGridColumnFixing("unfixNonDataColumns");
-
ui-icon ui-iggrid-icon-unfix
- Classes applied in feature chooser icon when column is not fixed.
-
ui-icon ui-iggrid-icon-fix
- Classes applied in feature chooser icon when column is fixed.
-
ui-iggrid-fixedcontainer
- Classes applied to the main fixed container.
-
ui-icon ui-corner-all ui-icon-pin-w
- Classes applied to header cell button for fixing column.
-
ui-iggrid-fixcolumn-headerbuttoncontainer
- Classes applied to the container div of header button(which holds button for fixing/unfixing).
-
ui-icon ui-corner-all ui-icon-pin-s
- Classes applied to header cell button for unfixing column.
-
ui-iggrid-fixedcontainer-left
- Classes applied to the left side container.
-
ui-iggrid-fixedcontainer-right
- Classes applied right side fixed container.
-
ui-iggrid-unfixed-table-left
- Classes applied in unfixed table when fixing direction is left.
-
ui-iggrid-unfixed-table-right
- Classes applied in unfixed table when fixing direction is right.