jQWidgets jqxTreeGrid getColumnProperty() Method

Last Updated : 30 Sep, 2021

jQWidgets is a JavaScript framework for making web-based applications for PC and mobile devices. It is a very powerful, optimized, platform-independent, and widely supported framework. The jqxTreeGrid is used for representing data in a tree-like structure. This widget is useful for displaying multi-column of hierarchical data, data paging, sorting and filtering, data editing, column resizing, fixed columns, conditional formatting, aggregates, and rows selection. These widgets also read and display the data from any type of data source such as XML, JSON, Array, CSV, or TSV.

The getColumnProperty() method is used to get the property value for a column of the specified jqxTreeGrid.

Syntax:

$("#treeGrid").jqxTreeGrid('getColumnProperty', dataField, propertyName);

Parameters: This method accepts two parameters that are illustrated below:

dataField: This is the specified data field or column for which the property value will be returned.
propertyName: This is the specified property name against which property value will be returned for the specified column.

Return Values: This method returns the property value.

Linked Files: Download jQWidgets from the given link. In the HTML file, locate the script files in the downloaded folder.

<link rel=”stylesheet” href=”jqwidgets/styles/jqx.base.css” type=”text/css” />
<script type=”text/javascript” src=”scripts/jquery.js”></script>
<script type=”text/javascript” src=”jqwidgets/jqxcore.js”></script>
<script type=”text/javascript” src=”jqwidgets/jqxdata.js”></script>
<script type=”text/javascript” src=”jqwidgets/jqxbuttons.js”></script>
<script type=”text/javascript” src=”jqwidgets/jqxscrollbar.js”></script>
<script type=”text/javascript” src=”jqwidgets/jqxlistbox.js”></script>
<script type=”text/javascript” src=”jqwidgets/jqxdropdownlist.js”></script>
<script type=”text/javascript” src=”jqwidgets/jqxdatatable.js”></script>
<script type=”text/javascript” src=”jqwidgets/jqxtreegrid.js”></script>

Example: The below example illustrates the jQWidgets jqxTreeGrid getColumnProperty() method. In the below example, a property value for the property name ‘align’ of the “Company” column is returned.

HTML

<!DOCTYPE html> 
<html lang="en"> 
  
<head> 
    <link rel="stylesheet" href=" 
jqwidgets/styles/jqx.base.css" type="text/css"/> 
    <script type="text/javascript" 
            src="scripts/jquery.js"> 
    </script> 
    <script type="text/javascript" 
            src="jqwidgets/jqxcore.js"> 
    </script> 
    <script type="text/javascript" 
            src="jqwidgets/jqxdata.js"> 
    </script> 
    <script type="text/javascript" 
            src="jqwidgets/jqxbuttons.js"> 
    </script> 
    <script type="text/javascript" 
            src="jqwidgets/jqxscrollbar.js"> 
    </script> 
    <script type="text/javascript" 
            src="jqwidgets/jqxlistbox.js"> 
    </script> 
    <script type="text/javascript" 
            src="jqwidgets/jqxdropdownlist.js"> 
    </script> 
    <script type="text/javascript" 
            src="jqwidgets/jqxdatatable.js"> 
    </script> 
    <script type="text/javascript" 
            src="jqwidgets/jqxtreegrid.js"> 
    </script> 
</head> 
  
<body> 
    <center> 
        <h1 style="color: green;"> 
            GeeksforGeeks 
        </h1> 
        <h3> 
            jQWidgets jqxTreeGrid getColumnProperty() Method 
        </h3> 
        <div id="jqxTreeGrid" style="margin: 25px;"> 
        </div> 
        <input type="button" style="margin: 20px;" 
               id="button_for_getColumnProperty"
               value="Get the align property value 
                         for the second column"/> 
        <div id="log"></div> 
        <script type="text/javascript"> 
            $(document).ready(function () { 
                var A = [{ 
                    "ID": 1, 
                    "Employee_Name": "Amit", 
                    "Company": "GeeksforGeeks", 
                    "Designation": "Content Writer", 
                    "expanded": true, 
                    A1: [{ 
                        "ID": 2, 
                        "Employee_Name": "Sumit", 
                        "Company": "Amazon", 
                        "Designation": "Software Engineer", 
                    }, { 
                        "ID": 3, 
                        "Employee_Name": "Vivek", 
                        "Company": "Apple", 
                        "Designation": "Product Manager", 
                        "expanded": true, 
                        A1: [{ 
                            "ID": 4, 
                            "Employee_Name": "Soni", 
                            "Company": "Flipkart", 
                            "Designation": "HR", 
                        }] 
                    }] 
                }]; 
  
                var Data_Source = { 
                    dataFields: [{ 
                        name: 'ID' 
                    }, { 
                        name: 'Employee_Name' 
                    }, { 
                        name: 'Company' 
                    }, { 
                        name: 'Designation' 
                    }, { 
                        name: 'A1', 
                        type: 'array' 
                    }, { 
                        name: 'expanded' 
                    }], 
                    hierarchy: { 
                        root: 'A1' 
                    }, 
                    id: 'ID', 
                    localData: A 
                }; 
  
                var Data = new 
                    $.jqx.dataAdapter(Data_Source); 
  
                $("#jqxTreeGrid").jqxTreeGrid({ 
                    source: Data, 
                    sortable: true, 
                    ready: function () { 
                        $("#jqxTreeGrid").jqxTreeGrid( 
                            'expandRow', '1'); 
                    }, 
                    ready: function () { 
                        $("#jqxTreeGrid").jqxTreeGrid( 
                            'expandRow', '3'); 
                    }, 
                    columns: [{ 
                        text: 'Employee_Name', 
                        align: 'center', 
                        dataField: 'Employee_Name', 
                        width: 140 
                    }, { 
                        text: 'Company', 
                        align: 'center', 
                        dataField: 'Company', 
                        width: 150 
                    }, { 
                        text: 'Designation', 
                        align: 'center', 
                        dataField: 'Designation', 
                        width: 150 
                    }] 
  
                }); 
                $("#button_for_getColumnProperty").jqxButton({ 
                    width: 350, 
                    height: 35 
                }); 
                $('#button_for_getColumnProperty').click( 
                    function () { 
                        var property = $("#jqxTreeGrid"). 
                        jqxTreeGrid( 
                            'getColumnProperty', 'Company', 
                            'align'); 
                        $("#log").html(JSON.stringify( 
                            property)) 
                    }); 
            }); 
        </script> 
    </center> 
</body> 
  
</html>