Vue Map Props
accessKey
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
apiKey
If you have more than one map provider in your application, specify the keys in the object fields as shown below. Otherwise, you can assign the key directly to the apiKey property.
jQuery
$(function() { $("#mapContainer").dxMap({ // ... apiKey: { bing: "MY_BING_MAPS_KEY", google: "MY_GOOGLE_MAPS_KEY", googleStatic: "MY_GOOGLE_STATIC_MAPS_KEY" } }); });
Angular
<dx-map ... > <dxo-api-key bing="MY_BING_MAPS_KEY" google="MY_GOOGLE_MAPS_KEY" googleStatic="MY_GOOGLE_STATIC_MAPS_KEY"> </dxo-api-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 ... > <DxApiKey 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, { DxApiKey } from 'devextreme-vue/map'; export default { components: { DxMap, DxApiKey } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import Map, { ApiKey } from 'devextreme-react/map'; const App = () => { return ( <Map ... > <ApiKey bing="MY_BING_MAPS_KEY" google="MY_GOOGLE_MAPS_KEY" googleStatic="MY_GOOGLE_STATIC_MAPS_KEY" /> </Map> ); } export default App;
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.
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;
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; }
key
Use the apiKey property instead.
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
To set a custom icon for an individual marker, specify the iconSrc field of the corresponding marker data source object.
markers[]
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
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. |
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.
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
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
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). |
onMarkerRemoved
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. |
onOptionChanged
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
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
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). |
onRouteRemoved
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. |
provider
Use the "googleStatic" provider to connect route points directly rather than by following the street layout.
rtlEnabled
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 });
tabIndex
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
type
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
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.