jQuery Map API
DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.
The following code shows how to create the Map widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.
jQuery
$(function () {
$("#map").dxMap({
provider: 'bing',
type: 'roadmap',
zoom: 10,
center: "40.749825, -73.987963"
});
});<div id="map"></div>
Angular
<dx-map
provider="bing"
type="roadmap"
[zoom]="10"
center="40.749825, -73.987963">
</dx-map>
import { DxMapModule } from 'devextreme-angular';
// ...
export class AppComponent {
// ...
}
@NgModule({
imports: [
// ...
DxMapModule
],
// ...
})AngularJS
<div dx-map="{
provider: 'bing',
type: 'roadmap',
zoom: 10,
center: '40.749825, -73.987963'
}"></div>Knockout
<div data-bind="dxMap: {
provider: 'bing',
type: 'roadmap',
zoom: 10,
center: '40.749825, -73.987963'
}"></div>ASP.NET MVC Controls
@(Html.DevExtreme().Map()
.ID("map")
.Provider(GeoMapProvider.Bing)
.Type(GeoMapType.Roadmap)
.Zoom(10)
.Center(40.749825, -73.987963)
)@(Html.DevExtreme().Map() _
.ID("map") _
.Provider(GeoMapProvider.Bing) _
.Type(GeoMapType.Roadmap) _
.Zoom(10) _
.Center(40.749825, -73.987963)
)See Also
Configuration
| Name | Description |
|---|---|
| accessKey |
Specifies the shortcut key that sets focus on the widget. |
| activeStateEnabled |
Specifies whether or not the widget changes its state when interacting with a user. |
| autoAdjust |
Specifies whether the widget automatically adjusts center and zoom option values when adding a new marker or route, or if a new widget contains markers or routes by default. |
| center |
An object, a string, or an array specifying which part of the map is displayed at the widget's center using coordinates. The widget can change this value if autoAdjust is enabled. |
| controls |
Specifies whether or not map widget controls are available. |
| disabled |
Specifies whether the widget responds to user interaction. |
| elementAttr |
Specifies the attributes to be attached to the widget's root element. |
| focusStateEnabled |
Specifies whether the widget can be focused using keyboard navigation. |
| height |
Specifies the widget's height. |
| hint |
Specifies text for a hint that appears when a user pauses on the widget. |
| hoverStateEnabled |
Specifies whether the widget changes its state when a user pauses on it. |
| key |
A key used to authenticate the application within the required map provider. |
| markerIconSrc |
A URL pointing to the custom icon to be used for map markers. |
| markers |
An array of markers displayed on a map. |
| onClick |
A handler for the click event. |
| onDisposing |
A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only. |
| onInitialized |
A handler for the initialized event. Executed only once, after the widget is initialized. |
| onMarkerAdded |
A handler for the markerAdded event. |
| onMarkerRemoved |
A handler for the markerRemoved event. |
| onOptionChanged |
A handler for the optionChanged event. Executed after an option of the widget is changed. |
| onReady |
A handler for the ready event. |
| onRouteAdded |
A handler for the routeAdded event. |
| onRouteRemoved |
A handler for the routeRemoved event. |
| provider |
The name of the current map data provider. |
| routes |
An array of routes shown on the map. |
| rtlEnabled |
Switches the widget to a right-to-left representation. |
| tabIndex |
Specifies the number of the element when the Tab key is used for navigating. |
| type |
The type of a map to display. |
| visible |
Specifies whether the widget is visible. |
| width |
Specifies the widget's width. |
| zoom |
The map's zoom level. The widget can change this value if autoAdjust is enabled. |
Methods
| Name | Description |
|---|---|
| addMarker(markerOptions) |
Adds a marker to the map. |
| addRoute(routeOptions) |
Adds a route to the map. |
| beginUpdate() |
Prevents the widget from refreshing until the endUpdate() method is called. |
| defaultOptions(rule) |
Specifies the device-dependent default configuration options for this component. |
| dispose() |
Disposes of all the resources allocated to the Map instance. |
| element() |
Gets the root widget element. |
| endUpdate() |
Refreshes the widget after a call of the beginUpdate() method. |
| focus() |
Sets focus on the widget. |
| getInstance(element) |
Gets the instance of a widget found using its DOM node. |
| instance() |
Gets the widget's instance. Use it to access other methods of the widget. |
| off(eventName) |
Detaches all event handlers from a single event. |
| off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) |
Subscribes to an event. |
| on(events) |
Subscribes to events. |
| option() |
Gets all widget options. |
| option(optionName) |
Gets the value of a single option. |
| option(optionName, optionValue) |
Updates the value of a single option. |
| option(options) |
Updates the values of several options. |
| registerKeyHandler(key, handler) |
Registers a handler to be executed when a user presses a specific key. |
| removeMarker(marker) |
Removes a marker from the map. |
| removeRoute(route) |
Removes a route from the map. |
| repaint() |
Repaints the widget. Call it if you made modifications that changed the widget's state to invalid. |
Events
| Name | Description |
|---|---|
| click |
Fires when the map is clicked. |
| disposing |
Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only. |
| initialized |
Raised only once, after the widget is initialized. |
| markerAdded |
Fires after a marker is added to the map. |
| markerRemoved |
Fires after a marker is removed from the map. |
| optionChanged |
Raised after a widget option is changed. |
| ready |
Fires after a map is rendered. |
| routeAdded |
Fires after a route is added to the map. |
| routeRemoved |
Fires after a route is removed from the map. |