⛔ DEPRECATED. This project was moved to a new repository. Visit dashboard-extensions to find an updated version.
The current repository does not support the modular approach for HTML JS Dashboard and will not be updated in the future.
The Online Map extension is a custom dashboard item that allows you to place callouts on Google or Bing maps using geographical coordinates.
This custom item supports the Master-Filtering feature.
-
Download the latest version of scripts here.
-
Add the dist folder in your project.
-
Attach the download script to the project inside the
<body>section before the end tag onto the page containing Web Dashboard.
<body>
<!-- ... -->
<script src="/dist/online-map-extension.min.js"></script>
</body>- Handle the Web Dashboard's BeforeRender event to perform client-side customization of the Web Dashboard control before the control and its elements have been rendered.
<!-- For ASP.NET Web Forms -->
<dx:ASPxDashboard ID="ASPxDashboard1" runat="server" DashboardStorageFolder="~/App_Data/Dashboards">
<ClientSideEvents BeforeRender="onBeforeRender" />
</dx:ASPxDashboard>@* For ASP.NET MVC *@
@Html.DevExpress().Dashboard(settings => {
settings.Name = "Dashboard";
settings.ClientSideEvents.BeforeRender = "onBeforeRender";
}).GetHtml()- Register the custom item extension to add the Online Map to the Web Dashboard.
function onBeforeRender(sender) {
var dashboardControl = sender.GetDashboardControl();
dashboardControl.registerExtension(new CustomItems.OnlineMapItemExtension(dashboardControl));
}
</script>Note that Map JavaScript API applications require an authentication key of a certain provider. Use the dxMap's key attribute to provide authentication keys.
For more information on authentication keys, see the required map provider documentation (e.g., Google or Bing).
The Online Map dashboard item supports the following settings that you can configure in the Web Dashboard UI:
- Provider - Specifies whether to show Google or Bing maps.
- Type - Specifies the map type. You can choose between RoadMap, Satellite or Hybrid.
- Display Mode - Specifies whether to show markers or routes.
You can use this extension code as a base for your own dashboard item extension development.
Before you start, we advise you to fork this repository and work with your own copy.
- Clone this extension to get a local copy of the repository.
git clone https://github.com/DevExpress/dashboard-extension-online-map-item.git
cd dashboard-extension-online-map-item- In this extension we use the Node.js toolset. Use the command below to install all modules listed as dependencies in the extension's package.json file.
npm install- Then install Gulp to build the solution. You can install it globally...
npm install -g gulp
gulp build... or use a local Gulp version.
.\node_modules\.bin\gulp buildYou can find the resulting files at ...\dashboard-extension-online-map-item\dist:
online-map-extension.js and online-map-extension.min.js.
This extension is distributed under the MIT license (free and open-source), but can only be used with a commercial DevExpress Dashboard software product. You can review the license terms or download a free trial version of the Dashboard suite at DevExpress.com.
- Refer to this section for general information about client-side extensions.
- To learn how to create a custom item, see the following KB article.
- To address questions regarding the Web Dashboard and JavaScript API, use DevExpress Support Center.
