jqGrid supports tree-grid mode, where you can display rows of data of the same structure (column definition)
as hierarchial tree structure. In your model, just set the
TreeGridSettings.Enabled property to true
and the grid will be assuming tree-mode response from the server (see the
Model code tab for details).
This means that in addition to the row data, you need to return data that will help jqGrid determine the hierarchy of the rows.
When selecting rows, you need to specify some or all of the following reserved fields
- tree_level - the level of the row in the tree hierarchy. 0 is for root row.
- tree_leaf - if the row is leaf (no child rows). This will make it non-expandable and will have an alternative icon.
- tree_expanded - if the row is expanded by default or not.
- tree_parent - the primary key (ID) of the parent row (only applicable for child rows)
- tree_loaded - true/false - if the tree nodes are already loaded. Can be used to show several levels expanded by default.
You can also control the different images per grid rows - in expanded, collapsed and leaf states. This can be achieved with the following properties available from the
TreeGridSettings collection -
ExpandedIcon,
CollapsedIcon,
LeafIcon
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using Trirand.Web.Mvc;
using System.Web.UI.WebControls;
namespace JQGridMVCExamples.Models
{
public class RetailDataJqGridModel
{
public JQGrid RetailDataGrid { get; set; }
public RetailDataJqGridModel()
{
RetailDataGrid = new JQGrid
{
Columns = new List()
{
new JQGridColumn { DataField = "ID",
PrimaryKey = true,
Visible = false,
},
new JQGridColumn { DataField = "Name", Width = 200 },
new JQGridColumn { DataField = "Quantity" },
new JQGridColumn { DataField = "Price" },
new JQGridColumn { DataField = "Color"}
},
Width = Unit.Pixel(650),
Height = Unit.Percentage(300),
TreeGridSettings = new TreeGridSettings
{
Enabled = true
}
};
}
}
}
<%@ Page Language="C#" Inherits="System.Web.Mvc.ViewPage<JQGridMVCExamples.Models.RetailDataJqGridModel>" %>
<%@ Import Namespace="Trirand.Web.Mvc" %>
<%@ Import Namespace="JQGridMVCExamples.Models" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>jqGrid TreeGrid - Load Rows On Demand</title>
<script type="text/javascript" src="http://ajax.microsoft.com/ajax/jquery/jquery-1.7.1.min.js"></script>
<script type="text/javascript" src="http://www.trirand.net/aspnetmvc/Scripts/trirand/i18n/grid.locale-en.js"></script>
<script type="text/javascript" src="http://www.trirand.net/aspnetmvc/Scripts/trirand/jquery.jqGrid.min.js"></script>
<link rel="stylesheet" type="text/css" href="http://ajax.aspnetcdn.com/ajax/jquery.ui/1.8.16/themes/redmond/jquery-ui.css" />
<link rel="stylesheet" type="text/css" href="http://www.trirand.net/aspnetmvc/Content/themes/ui.jqgrid.css" />
</head>
<body>
<div>
<%= Html.Trirand().JQGrid(Model.RetailDataGrid, "Retail") %>
</div>
<br /><br />
<div>
<% Html.RenderPartial("CodeTabs"); %>
</div>
</body>
</html>
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using System.Web.Mvc.Ajax;
using JQGridMVCExamples.Models;
using System.Web.UI.WebControls;
using Trirand.Web.Mvc;
namespace JQGridMVCExamples.Controllers.Grid
{
public partial class GridController : Controller
{
// This is the default action for the View. Use it to setup your grid Model.
public ActionResult TreeRowsOnDemand()
{
// Get the model (setup) of the grid defined in the /Models folder.
var gridModel = new RetailDataJqGridModel();
var grid = gridModel.RetailDataGrid;
// Setting the DataUrl to an action (method) in the controller is required.
// This action will return the data needed by the grid
grid.DataUrl = Url.Action("TreeAutoLoading_DataRequested");
// set grid tree mode to on.
grid.TreeGridSettings.Enabled = true;
// Pass the custmomized grid model to the View
return View(gridModel);
}
// This method is called when the grid requests data. You can choose any method to call
// by setting the JQGrid.DataUrl property
public JsonResult TreeAutoLoading_DataRequested()
{
// Get both the grid Model and the data Model
// The data model in our case is an autogenerated linq2sql database based on Northwind.
var gridModel = new RetailDataJqGridModel();
var northWindModel = new NorthwindDataContext();
var grid = gridModel.RetailDataGrid;
IQueryable queryResult;
JQGridTreeExpandData expandData = grid.GetTreeExpandData();
// ********************************************************************************************
// when selecting rows, you need to specify some or all of the following reserved fields
// tree_level - the level of the row in the tree hierarchy. 0 is for root row.
// tree_leaf - if the row is leaf (no child rows). This will make it non-expandable and will have an alternative icon
// tree_expanded - if the row is expanded by default or not
// tree_parent - the primary key (ID) of the parent row (only applicable for child rows)
// tree_loaded - true/false - if the tree nodes are already loaded. Can be used to show several levels expanded by default.
// ********************************************************************************************
// parent tree - root rows only
if (expandData.ParentID == null)
{
queryResult = from product in northWindModel.RetailDatas
where (product.ParentID == null)
select new
{
ID = product.ID,
Name = product.Name,
Price = product.Price,
Color = product.Color,
Quantity = product.Quantity,
tree_level = 0,
tree_leaf = IsLeafRow(product.ID),
tree_expanded = false
};
}
// child nodes
else
{
int parentID = Convert.ToInt32(expandData.ParentID);
int level = expandData.ParentLevel + 1;
queryResult = from product in northWindModel.RetailDatas
where (product.ParentID == parentID)
select new
{
ID = product.ID,
Name = product.Name,
Price = product.Price,
Color = product.Color,
Quantity = product.Quantity,
tree_level = level,
tree_leaf = IsLeafRow(product.ID),
tree_expanded = false,
tree_parent = parentID
};
}
return grid.DataBind(queryResult);
}
private bool IsLeafRow(int productID)
{
var northWindModel = new NorthwindDataContext();
int childCount =
(from product in northWindModel.RetailDatas
from joinProduct in northWindModel.RetailDatas
where (product.ID == joinProduct.ParentID)
where (product.ID == productID)
select product).Count();
return childCount == 0;
}
}
}
Switch theme:
Theming is based on the very popular jQuery
ThemeRoller standard. This is the same theming mechanism used by jQuery UI and is now a de-facto standard for jQuery based components.
The benefits of using ThemeRoller are huge. We can offer a big set of ready to use themes created by professional designers, including Windows-like themes (Redmond), Apple-like theme (Cupertino), etc.
In addition to that any jQuery UI controls on the same page will pick the same theme.
Last, but not least, you can always roll your own ThemeRoller theme, using the superb
Theme Editor
To use a theme, simply reference 2 Css files in your Html <head> section - the ThemeRoller theme you wish to use, and the jqGrid own ThemeRoller Css file. For example (Redmond theme):
<link rel="stylesheet" type="text/css" media="screen" href="/themes/redmond/jquery-ui-1.8.2.custom.css" />
<link rel="stylesheet" type="text/css" media="screen" href="/themes/ui.jqgrid.css" />