jQuery Grid: Foreign Key Column

Create a Grid with a Foreign Key column.

A live JavaScript/jQuery example of jqxGrid, the jQWidgets Grid component, with its complete source code below. It is one of 139 jqxGrid demos for jQuery.

jqxGrid API used in this demo

Source code

To run it in your own page, load jqx.base.css, a theme and the library files below from npm (npm install jqwidgets-scripts) or the jsDelivr CDN, then add the markup and the script. jQuery is not required: jqxcore.js provides $. Getting started with jqxGrid shows the setup step by step.

The page loads jqx.base.css, a theme and these library files: jqxcore.js, jqxdata.js, jqxbuttons.js, jqxscrollbar.js, jqxmenu.js, jqxgrid.js, jqxgrid.selection.js, jqxgrid.pager.js, jqxlistbox.js, jqxgrid.edit.js, jqxdropdownlist.js, jqxcombobox.js, jqxpanel.js.

It also loads helper scripts of this demo site, which are not part of the library: demos.js (getWidth() and other layout helpers).

script.js

$(document).ready(function () {
    var employeesSource =
     {
         datatype: "xml",
         datafields: [
             { name: 'FirstName', type: 'string' },
             { name: 'LastName', type: 'string' }
         ],
         root: "Employees",
         record: "Employee",
         id: 'EmployeeID',
         url: "../sampledata/employees.xml",
         async: false
     };

    var employeesAdapter = new $.jqx.dataAdapter(employeesSource, {
        autoBind: true,
        beforeLoadComplete: function (records) {
            var data = new Array();
            // update the loaded records. Dynamically add EmployeeName and EmployeeID fields. 
            for (var i = 0; i < records.length; i++) {
                var employee = records[i];
                employee.EmployeeName = employee.FirstName + " " + employee.LastName;
                employee.EmployeeID = employee.uid;
                data.push(employee);
            }
            return data;
        }
    });

    // prepare the data
    var ordersSource =
    {
        datatype: "xml",
        datafields: [
            // name - determines the field's name.
            // values - specifies the field's values.
            // values.source - specifies the foreign source. The expected value is an array.
            // values.name - specifies the field's name in the foreign source. 
            // When the ordersAdapter is loaded, each record will have a field called "EmployeeID". The "EmployeeID" for each record will come from the employeesAdapter where the record's "EmployeeID" from orders.xml matches to the "EmployeeID" from employees.xml. 
            { name: 'EmployeeID', map: 'm\\:properties>d\\:EmployeeID', values: { source: employeesAdapter.records, name: 'EmployeeName' } },
            { name: 'ShippedDate', map: 'm\\:properties>d\\:ShippedDate', type: 'date' },
            { name: 'Freight', map: 'm\\:properties>d\\:Freight', type: 'float' },
            { name: 'ShipName', map: 'm\\:properties>d\\:ShipName' },
            { name: 'ShipAddress', map: 'm\\:properties>d\\:ShipAddress' },
            { name: 'ShipCity', map: 'm\\:properties>d\\:ShipCity' },
            { name: 'ShipCountry', map: 'm\\:properties>d\\:ShipCountry' }
        ],
        root: "entry",
        record: "content",
        id: 'm\\:properties>d\\:OrderID',
        url: "../sampledata/orders.xml",
        pager: function (pagenum, pagesize, oldpagenum) {
            // callback called when a page or page size is changed.
        }
    };
    var ordersAdapter = new $.jqx.dataAdapter(ordersSource);

    $("#grid").jqxGrid(
    {
        width: getWidth('Grid'),
        source: ordersAdapter,
        selectionmode: 'multiplecellsextended',
        pageable: true,
        autoheight: true,
        columns: [
            { text: 'Employee Name', datafield: 'EmployeeID', width: 150 },
            { text: 'Ship City', datafield: 'ShipCity', width: 150},
            { text: 'Ship Country', datafield: 'ShipCountry', width: 150 },
            { text: 'Ship Name', datafield: 'ShipName'}
        ]
    });
});

body.html

<div id="jqxWidget">
    <div id="grid">
    </div>
</div>

Learn more

More jQuery Grid demos