Toolbar Customization
Documentation
The DataGrid widget allows you to customize its toolbar using the onToolbarPreparing function. You can add new items to the toolbar or customize the existing ones. In this demo, the toolbar contains a collection of other widgets from the DevExtreme HTML5 UI Widgets library.
Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you!
We appreciate your feedback.
We appreciate your feedback.
window.onload = function() {
var expanded = ko.observable(true),
expandButtonText = ko.observable("Collapse All");
expanded.subscribe(function(newValue) {
expandButtonText(newValue ? "Collapse All" : "Expand All");
});
var viewModel = {
totalCount: ko.observable(getGroupCount("CustomerStoreState")),
dataGridOptions: {
dataSource: orders,
showBorders: true,
grouping: {
autoExpandAll: expanded
},
columnChooser: {
enabled: true
},
loadPanel: {
enabled: true
},
columns: [{
dataField: "OrderNumber",
caption: "Invoice Number"
}, "OrderDate", "Employee", {
caption: "City",
dataField: "CustomerStoreCity"
}, {
caption: "State",
groupIndex: 0,
dataField: "CustomerStoreState",
}, {
dataField: "SaleAmount",
alignment: "right",
format: "currency"
}],
onToolbarPreparing: function(e) {
var dataGrid = e.component;
e.toolbarOptions.items.unshift({
location: "before",
template: "totalGroupCount"
}, {
location: "before",
widget: "dxSelectBox",
options: {
width: 200,
items: [{
value: "CustomerStoreState",
text: "Grouping by State"
}, {
value: "Employee",
text: "Grouping by Employee"
}],
displayExpr: "text",
valueExpr: "value",
value: "CustomerStoreState",
onValueChanged: function(e) {
dataGrid.clearGrouping();
dataGrid.columnOption(e.value, "groupIndex", 0);
viewModel.totalCount(getGroupCount(e.value));
}
}
}, {
location: "before",
widget: "dxButton",
options: {
text: expandButtonText,
width: 136,
onClick: function(e) {
expanded(!expanded());
}
}
}, {
location: "after",
widget: "dxButton",
options: {
icon: "refresh",
onClick: function() {
dataGrid.refresh();
}
}
});
}
}
};
function getGroupCount(groupField) {
return DevExpress.data.query(orders)
.groupBy(groupField)
.toArray().length;
}
ko.applyBindings(viewModel, document.getElementById("gridContainer"));
};
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>DevExtreme Demo</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
<script>window.jQuery || document.write(decodeURIComponent('%3Cscript src="js/jquery.min.js"%3E%3C/script%3E'))</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/knockout/3.4.2/knockout-min.js"></script>
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/19.1.5/css/dx.common.css" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/19.1.5/css/dx.light.css" />
<script src="https://cdn3.devexpress.com/jslib/19.1.5/js/dx.all.js"></script>
<script src="data.js"></script>
<link rel="stylesheet" type="text/css" href="styles.css" />
<script src="index.js"></script>
</head>
<body class="dx-viewport">
<div class="demo-container">
<div id="gridContainer" data-bind="dxDataGrid: dataGridOptions">
<div data-options="dxTemplate:{ name:'totalGroupCount' }">
<div class="informer">
<h2 class="count" data-bind="text: $parent.totalCount"></h2>
<span class="name">Total Count</span>
</div>
</div>
</div>
</div>
</body>
</html>
#gridContainer .dx-datagrid-header-panel {
padding: 0;
background-color: rgba(85, 149, 222, 0.6);
}
#gridContainer .dx-datagrid-header-panel .dx-toolbar {
margin: 0;
padding-right: 20px;
background-color: transparent;
}
#gridContainer .dx-datagrid-header-panel .dx-toolbar-items-container {
height: 70px;
}
#gridContainer .dx-datagrid-header-panel .dx-toolbar-before .dx-toolbar-item:not(:first-child) {
background-color: rgba(103, 171, 255, 0.6);
}
#gridContainer .dx-datagrid-header-panel .dx-toolbar-before .dx-toolbar-item:last-child {
padding-right: 10px;
}
#gridContainer .dx-datagrid-header-panel .dx-selectbox {
margin: 17px 10px;
}
#gridContainer .dx-datagrid-header-panel .dx-button {
margin: 17px 0;
}
#gridContainer .informer {
height: 70px;
width: 130px;
text-align: center;
color: #fff;
}
#gridContainer .count {
padding-top: 15px;
line-height: 27px;
margin: 0;
}
var orders = [{
"ID" : 1,
"OrderNumber" : 35703,
"OrderDate" : new Date(2014, 3, 10),
"SaleAmount" : 11800,
"Terms" : "15 Days",
"TotalAmount" : 12175,
"CustomerStoreState" : "California",
"CustomerStoreCity" : "Los Angeles",
"Employee" : "Harv Mudd"
}, {
"ID" : 4,
"OrderNumber" : 35711,
"OrderDate" : new Date(2014, 0, 12),
"SaleAmount" : 16050,
"Terms" : "15 Days",
"TotalAmount" : 16550,
"CustomerStoreState" : "California",
"CustomerStoreCity" : "San Jose",
"Employee" : "Jim Packard"
}, {
"ID" : 5,
"OrderNumber" : 35714,
"OrderDate" : new Date(2014, 0, 22),
"SaleAmount" : 14750,
"Terms" : "15 Days",
"TotalAmount" : 15250,
"CustomerStoreState" : "Nevada",
"CustomerStoreCity" : "Las Vegas",
"Employee" : "Harv Mudd"
}, {
"ID" : 7,
"OrderNumber" : 35983,
"OrderDate" : new Date(2014, 1, 7),
"SaleAmount" : 3725,
"Terms" : "15 Days",
"TotalAmount" : 3850,
"CustomerStoreState" : "Colorado",
"CustomerStoreCity" : "Denver",
"Employee" : "Todd Hoffman"
}, {
"ID" : 9,
"OrderNumber" : 36987,
"OrderDate" : new Date(2014, 2, 11),
"SaleAmount" : 14200,
"Terms" : "15 Days",
"TotalAmount" : 14800,
"CustomerStoreState" : "Utah",
"CustomerStoreCity" : "Salt Lake City",
"Employee" : "Clark Morgan"
}, {
"ID" : 11,
"OrderNumber" : 38466,
"OrderDate" : new Date(2014, 2, 1),
"SaleAmount" : 7800,
"Terms" : "15 Days",
"TotalAmount" : 8200,
"CustomerStoreState" : "California",
"CustomerStoreCity" : "Los Angeles",
"Employee" : "Harv Mudd"
}, {
"ID" : 14,
"OrderNumber" : 39420,
"OrderDate" : new Date(2014, 1, 15),
"SaleAmount" : 20500,
"Terms" : "15 Days",
"TotalAmount" : 9100,
"CustomerStoreState" : "California",
"CustomerStoreCity" : "San Jose",
"Employee" : "Jim Packard"
}, {
"ID" : 15,
"OrderNumber" : 39874,
"OrderDate" : new Date(2014, 1, 4),
"SaleAmount" : 9050,
"Terms" : "30 Days",
"TotalAmount" : 19100,
"CustomerStoreState" : "Nevada",
"CustomerStoreCity" : "Las Vegas",
"Employee" : "Harv Mudd"
}, {
"ID" : 18,
"OrderNumber" : 42847,
"OrderDate" : new Date(2014, 1, 15),
"SaleAmount" : 20400,
"Terms" : "30 Days",
"TotalAmount" : 20800,
"CustomerStoreState" : "Wyoming",
"CustomerStoreCity" : "Casper",
"Employee" : "Todd Hoffman"
}, {
"ID" : 19,
"OrderNumber" : 43982,
"OrderDate" : new Date(2014, 4, 29),
"SaleAmount" : 6050,
"Terms" : "30 Days",
"TotalAmount" : 6250,
"CustomerStoreState" : "Utah",
"CustomerStoreCity" : "Salt Lake City",
"Employee" : "Clark Morgan"
}, {
"ID" : 29,
"OrderNumber" : 56272,
"OrderDate" : new Date(2014, 1, 6),
"SaleAmount" : 15850,
"Terms" : "30 Days",
"TotalAmount" : 16350,
"CustomerStoreState" : "Utah",
"CustomerStoreCity" : "Salt Lake City",
"Employee" : "Clark Morgan"
}, {
"ID" : 30,
"OrderNumber" : 57429,
"OrderDate" : new Date(2013, 11, 31),
"SaleAmount" : 11050,
"Terms" : "30 Days",
"TotalAmount" : 11400,
"CustomerStoreState" : "Arizona",
"CustomerStoreCity" : "Phoenix",
"Employee" : "Clark Morgan"
}];