JavaScript Customization of Dashboard Component
- 3 minutes to read
The Dashboard component for Blazor is a wrapper for the JavaScript DashboardControl. This makes the DashboardControl a single entry point for complex settings, such as custom items or custom properties. The DashboardControl configuration is common between all platforms and scripts become universal.
To customize a Dashboard component for Blazor with JavaScript, configure the underlying DashboardControl instance. For this, use properties of the DxJSCustomization class.
If you have JavaScript code that uses DashboardControl classes and properties, this code should be executed after scripts that the DxDashboard component requires. To do this, handle the OnScriptsLoading event and use the e.Scripts property to manage the script collection and load your scripts at the right time. The script order in the Scripts collection defines the loading order. To identify the collection’s items and manage the collection, use the ScriptIdentifiers constants.
Handle the DashboardControl Events
To handle the DashboardControl events, create an object in window and add event handlers. Pass the object name to the DxJSCustomization.Identifier property.
Register a Custom Extension
Follow the steps below to register a custom extension (for example, a custom item):
In
window, create an object with event handlers. Pass the object’s name to the DxJSCustomization.Identifier property.Register custom script files. Handle the DxJSCustomization.OnScriptsLoading event and add the custom script’s path to the e.Scripts collection.
Handle the DashboardControl’s onBeforeRender event and register the custom item extension with the DashboardControl.registerExtension method call.
See the example below for a code sample.
Examples
The example below shows how you can customize the Dashboard component with JavaScript:
- The DxJSCustomization class provides access to the DashboardControl event handlers.
- The onBeforeRender event handler registers the custom Parameter extension and removes the “New…” item from the dashboard menu.
- The onItemCaptionToolbarUpdated event handler adds a custom toolbar item to the Grid’s caption.
In this example, the name of the object with event handlers is dashboardEvents. This name is used in the DxJSCustomization.Identifier property.
window.dashboardEvents = {
onBeforeRender: (args) => {
// Registers the Parameter item and the Dashboard Panel.
var dashboardControl = args.component;
dashboardControl.registerExtension(new ParameterCustomItem(dashboardControl));
dashboardControl.registerExtension(new DevExpress.Dashboard.DashboardPanelExtension(dashboardControl));
// Removes the "New..." menu item from the dashboard menu.
var toolbox = dashboardControl.findExtension('toolbox');
var createItem = toolbox.menuItems().filter(item => item.id === "create-dashboard")[0];
toolbox.menuItems.remove(createItem);
},
// Adds a new custom toolbar item to the dashboard item caption.
extensions: {
viewerApi: {
onItemCaptionToolbarUpdated: function (e) {
if (e.itemName === "gridDashboardItem1") {
e.options.stateItems.push({
type: "menu",
icon: "baseCircle",
menu: {
type: "icons",
items: ["greenCircle", "yellowCircle", "redCircle"],
selectionMode: "none",
title: "Circles",
itemClick: function (itemData) {
alert(itemData.toString());
}
}
});
}
}
}
}
}