JavaScript/jQuery Map Options
An object defining configuration properties for the Map UI component.
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
accessKey
Specifies the shortcut key that sets focus on the UI component.
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
activeStateEnabled
Specifies whether or not the UI component changes its state when interacting with a user.
This property is used when the UI component is displayed on a platform whose guidelines include the active state change for UI components.
autoAdjust
Specifies whether the UI component automatically adjusts center and zoom property values when adding a new marker or route, or if a new UI component contains markers or routes by default.
If autoAdjust is enabled, zoom is set to the maximum value allowing all markers and routes to be displayed at the same time. The center is changed so that markers and routes are aligned with the UI component's center. Set the autoAdjust property to false to disable this behavior.
Note that the zoom level can only be automatically decreased to display all markers and routes. If the current zoom level allows all routes and markers to be displayed on the map, it remains unchanged.
center
An object, a string, or an array specifying which part of the map is displayed at the UI component's center using coordinates. The UI component can change this value if autoAdjust is enabled.
You can specify the center value in one of the following formats:
- { lat: 40.749825, lng: -73.987963}
- "40.749825, -73.987963"
- [40.749825, -73.987963]
- "Brooklyn Bridge,New York,NY"
When you use the Map as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control, this property accepts either a string value indicating the address, or two double
type values indicating the coordinates.
@(Html.DevExtreme().Map() .Center("Brooklyn Bridge,New York,NY") // ===== or ===== .Center(40.74982, -73.987963) )
@(Html.DevExtreme().Map() _ .Center("Brooklyn Bridge,New York,NY") _ ' ===== or ===== .Center(40.74982, -73.987963) )
controls
Specifies whether or not map UI component controls are available.
Assign a Boolean value to this property to enable or disable all controls at once - both the map navigation control and the map type control.
disabled
Specifies whether the UI component responds to user interaction.
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
jQuery
$(function(){ $("#mapContainer").dxMap({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-map ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-map>
import { DxMapModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxMapModule ], // ... })
Vue
<template> <DxMap ... :element-attr="mapAttributes"> </DxMap> </template> <script> import DxMap from 'devextreme-vue/map'; export default { components: { DxMap }, data() { return { mapAttributes: { id: 'elementId', class: 'class-name' } } } } </script>
React
import React from 'react'; import Map from 'devextreme-react/map'; class App extends React.Component { mapAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <Map ... elementAttr={this.mapAttributes}> </Map> ); } } export default App;
focusStateEnabled
Specifies whether the UI component can be focused using keyboard navigation.
height
Specifies the UI component's height.
This property accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
hint
Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled
Specifies whether the UI component changes its state when a user pauses on it.
key
A key used to authenticate the application within the required map provider.
jQuery
$(function() { $("#mapContainer").dxMap({ // ... key: { bing: "MY_BING_MAPS_KEY", google: "MY_GOOGLE_MAPS_KEY", googleStatic: "MY_GOOGLE_STATIC_MAPS_KEY" } }); });
Angular
<dx-map ... > <dxo-key bing="MY_BING_MAPS_KEY" google="MY_GOOGLE_MAPS_KEY" googleStatic="MY_GOOGLE_STATIC_MAPS_KEY"> </dxo-key> </dx-map>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxMapModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxMapModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxMap ... > <DxKey bing="MY_BING_MAPS_KEY" google="MY_GOOGLE_MAPS_KEY" googleStatic="MY_GOOGLE_STATIC_MAPS_KEY" /> </DxMap> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxMap, { DxKey } from 'devextreme-vue/map'; export default { components: { DxMap, DxKey } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import Map, { Key } from 'devextreme-react/map'; class App extends React.Component { render() { return ( <Map ... > <Key bing="MY_BING_MAPS_KEY" google="MY_GOOGLE_MAPS_KEY" googleStatic="MY_GOOGLE_STATIC_MAPS_KEY" /> </Map> ); } } export default App;
markerIconSrc
A URL pointing to the custom icon to be used for map markers.
To set a custom icon for an individual marker, specify the iconSrc field of the corresponding marker data source object.
markers[]
An array of markers displayed on a map.
If you use the Knockout approach when working with the Map UI component, you can pass an observable array to the markers property to easily manage markers.
onClick
A function that is executed when any location on the map is clicked or tapped.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution (if a static google provider is used). Deprecated in favor of the event field. |
|
location |
The clicked point's location on the map (if the "google" or "bing" provider is used). |
|
model |
Model data. Available only if Knockout is used. |
onDisposing
A function that is executed before the UI component is disposed of.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if you use Knockout. |
onInitialized
A function used in JavaScript frameworks to save the UI component instance.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onMarkerAdded
A function that is executed when a marker is created on the map.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
|
options |
The added marker's data. |
|
originalMarker |
The original marker that the current map provider uses (only for "google" and "bing" providers). |
See Also
onMarkerRemoved
A function that is executed when a marker is removed from the map.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
|
options |
The removed marker's data. |
See Also
onOptionChanged
A function that is executed after a UI component property is changed.
Information about the event.
Name | Type | Description |
---|---|---|
model |
Model data. Available only if you use Knockout. |
|
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
value | any |
The modified property's new value. |
The following example shows how to subscribe to component property changes:
jQuery
$(function() { $("#mapContainer").dxMap({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<dx-map ... (onOptionChanged)="handlePropertyChange($event)"> </dx-map>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... handlePropertyChange(e) { if(e.name === "changedProperty") { // handle the property change here } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxMapModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxMapModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxMap ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxMap from 'devextreme-vue/map'; export default { components: { DxMap }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import Map from 'devextreme-react/map'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <Map ... onOptionChanged={handlePropertyChange} /> ); }
onReady
A function that is executed when the map is ready.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
|
originalMap |
The current provider's map data. |
onRouteAdded
A function that is executed when a route is created on the map.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
|
options |
The added route's data. |
|
originalRoute |
The original route that the current map provider uses (only for "google" and "bing" providers). |
See Also
onRouteRemoved
A function that is executed when a route is removed from the map.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
|
options |
The removed route's data. |
See Also
provider
The name of the current map data provider.
Use the "googleStatic" provider to connect route points directly rather than by following the street layout.
Use the GeoMapProvider
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Bing
, Google
, and GoogleStatic
.
rtlEnabled
Switches the UI component to a right-to-left representation.
When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.
DevExpress.config({ rtlEnabled: true });
See Also
- Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors
tabIndex
Specifies the number of the element when the Tab key is used for navigating.
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
type
The type of a map to display.
The available property values are based on map types supported by the Google map provider. If you use the Bing map, the UI component casts the property value to the appropriate value supported by the "Bing" provider.
- hybrid -> Aerial
- roadmap -> Road
Use the GeoMapType
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Hybrid
, Roadmap
, and Satellite
.
width
Specifies the UI component's width.
This property accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
If you have technical questions, please create a support ticket in the DevExpress Support Center.