jQWidgets jqxTreeGrid virtualModeCreateRecords Property

Last Updated : 03 Oct, 2022

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 virtualModeCreateRecords property is a callback function that is helpful in loading data into the displayed jqxTreeGrid forcefully. Where, for each and every record, jqxTreeGrid invokes the virtualModeCreateRecords function simply when needed, which permits one to render data on request. Moreover, for enabling the loading on request feature, one must as well specify the virtualModeRecordCreating function. It is of Function type and its default value is null.

Parameters:

Row Key/ID: It is the stated row id/key which is the unique id/key of the row.
Done: It is the stated callback function that is invoked whenever the data is filled.

Syntax:

Set the virtualModeCreateRecords property:

$('Selector').jqxTreeGrid({ virtualModeCreateRecords: null });

Return the virtualModeCreateRecords property:

var virtualModeCreateRecords = 
    $('Selector').jqxTreeGrid('virtualModeCreateRecords');

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 1: The below example illustrates the jqxTreeGrid virtualModeCreateRecords property in jQWidgets.

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-1.11.1.min.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 virtualModeCreateRecords  
             Property  
        </h3> 
        <div id="jqxTreeGrid" style="margin: 25px;"> 
        </div> 
        <input type="button" style="margin: 29px;" 
               id="jqxbtn" value="Click here" /> 
        <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, 
                    virtualModeCreateRecords: true, 
                    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 
                    }] 
                }); 
                $("#jqxbtn").jqxButton({ 
                    width: 270 
                }); 
                $("#jqxbtn").on("click", function () { 
                    var vmcr =  
                        $('#jqxTreeGrid').jqxTreeGrid( 
                          'virtualModeCreateRecords'); 
                    $('#log').text(vmcr); 
                }); 
            }); 
        </script> 
    </center> 
</body> 
</html>

Output:

Example 2: The following is another example of the jqxTreeGrid virtualModeCreateRecords property in jQWidgets.

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-1.11.1.min.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 virtualModeCreateRecords  
             Property  
        </h3> 
        <div id="jqxTreeGrid" style="margin: 25px;"> 
        </div> 
        <input type="button" style="margin: 29px;" 
               id="jqxbtn" value="Click here" /> 
        <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, 
                    virtualModeCreateRecords: null, 
                    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 
                    }] 
                }); 
                $("#jqxbtn").jqxButton({ 
                    width: 270 
                }); 
                $("#jqxbtn").on("click", function () { 
                    var vmcr = 
                        $('#jqxTreeGrid').jqxTreeGrid( 
                              'virtualModeCreateRecords'); 
                    if (vmcr === null) { 
                        $('#log').text("Null!"); 
                    } 
                    else { 
                        $('#log').text("Not null!"); 
                    } 
                }); 
            }); 
        </script> 
    </center> 
</body> 
  
</html>