Configuration

An object defining configuration options for the Map widget.

accessKey

Specifies the shortcut key that sets focus on the widget.

Type:

String

Default Value: null

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

activeStateEnabled

Specifies whether or not the widget changes its state when interacting with a user.

Type:

Boolean

Default Value: false

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

autoAdjust

Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route, or when creating a widget if it initially contains markers or routes.

Type:

Boolean

Default Value: true

Note that the zoom level can only be decreased to display all markers and routes. If the current zoom level and center position allow all routes and markers to be displayed on the map, they remain unchanged.

center

An object, a string, or an array specifying the location displayed at the center of the widget.

Type:

Object

|

String

|

Array<Number>

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 Control, this option accepts either a string value indicating the address, or two values of the double type indicating the coordinates.

Razor C#
Razor VB
@(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 widget controls are available.

Type:

Boolean

Default Value: false

Assign a Boolean value to this option to enable or disable all controls at once - both the map navigation control and the map type control.

Show Example:
AngularJS
Knockout
jQuery

disabled

Specifies whether the widget responds to user interaction.

Type:

Boolean

Default Value: false

Show Example:
AngularJS
Knockout
jQuery

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Object

Default Value: {}

You can configure this option in an ASP.NET MVC Control as follows:

Razor C#
Razor VB
@(Html.DevExtreme().WidgetName()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)
@(Html.DevExtreme().WidgetName() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Boolean

Default Value: false
Default for generic: true

height

Specifies the widget's height.

This option accepts a value of one of the following types.

  • Number
    The height of the widget in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

hint

Specifies text for a hint that appears when a user pauses on the widget.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type:

Boolean

Default Value: false

key

A key used to authenticate the application within the required map provider.

Type:

String

|

Object

Default Value: ''

This option can hold a string representing an authentication key of a certain provider. In addition, this option can hold an object with specified keys for every used provider: { bing: BINGAPIKEY, google: GOOGLEAPIKEY, googleStatic: GOOGLESTATICAPI_KEY}.

For more information on authentication keys, see the required map provider documentation.

NOTE
The value of this option cannot be changed dynamically.

markerIconSrc

A URL pointing to the custom icon to be used for map markers.

Type:

String

To set a custom icon for an individual marker, specify the iconSrc field of the corresponding marker data source object.

View Demo

markers

An array of markers displayed on a map.

Type:

Array<Object>

If you use the Knockout approach when working with the Map widget, you can pass an observable array to the markers option to easily manage markers.

View Demo

Show Example:
AngularJS
Knockout
jQuery

onClick

A handler for the click event.

Type:

function

|

String

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

location:

Object

The clicked point's location on the map (if the 'google' or 'bing' provider is used).

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution (if a static google provider is used). Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

Assign a function to perform a custom action when the map is clicked.

To navigate to a specific URL when the click event fires, assign that URL or the anchor part (#) of that URL directly to this option as a string.

Show Example:
AngularJS
Knockout
jQuery

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.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onInitialized

A handler for the initialized event. Executed only once, after the widget is initialized.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

Default Value: null

You cannot access widget elements in this handler because it is executed before they are ready.

onMarkerAdded

A handler for the markerAdded event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

options:

Object

The added marker's data.

originalMarker:

Object

The original marker that the current map provider uses (only for 'google' and 'bing' providers).

Default Value: null

Assign a function to perform a custom action after a marker is added to the map.

Show Example:
AngularJS
Knockout
jQuery

onMarkerRemoved

A handler for the markerRemoved event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

options:

Object

The removed marker's data.

Default Value: null

Assign a function to perform a custom action after a marker is removed from the map.

Show Example:
AngularJS
Knockout
jQuery

onOptionChanged

A handler for the optionChanged event. Executed after an option of the widget is changed.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The option's new value.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onReady

A handler for the ready event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

originalMap:

Object

The current provider's map data.

Default Value: null

Assign a function to perform a custom action after a map is rendered.

onRouteAdded

A handler for the routeAdded event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

options:

Object

The added route's data.

originalRoute:

Object

The original route that the current map provider uses (only for 'google' and 'bing' providers).

Default Value: null

Assign a function to perform a custom action after a route is added to the map.

Show Example:
AngularJS
Knockout
jQuery

onRouteRemoved

A handler for the routeRemoved event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

options:

Object

The removed route's data.

Default Value: null

Assign a function to perform a custom action after a route is removed from the map.

Show Example:
AngularJS
Knockout
jQuery

provider

The name of the current map data provider.

Type:

String

Default Value: 'google'
Accepted Values: 'bing' | 'google' | 'googleStatic'

Use the "googleStatic" provider to connect route points directly rather than by following the street layout.

NOTE
Most browsers use Bing Maps V8, except Internet Explorer 9 and 10, which fall back to V7.

When using the widget as an ASP.NET MVC Control, specify this option using the GeoMapProvider enum. This enum accepts the following values: Bing, Google, and GoogleStatic.

View Demo

Show Example:
AngularJS
Knockout
jQuery

routes

An array of routes shown on the map.

Type:

Array<Object>

Show Example:
AngularJS
Knockout
jQuery

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Boolean

Default Value: false

When this option is set to true, the widget 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.

JavaScript
DevExpress.config({
    rtlEnabled: true
});

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

type

The type of a map to display.

Type:

String

Default Value: 'roadmap'
Accepted Values: 'hybrid' | 'roadmap' | 'satellite'

The available option values are based on map types supported by the Google map provider. If you use the Bing map, the widget casts the option value to the appropriate value supported by the "Bing" provider.

  • hybrid -> Aerial
  • roadmap -> Road

When using the widget as an ASP.NET MVC Control, specify this option using the GeoMapType enum. This enum accepts the following values: Hybrid, Roadmap and Satellite.

View Demo

Show Example:
AngularJS
Knockout
jQuery

visible

Specifies whether the widget is visible.

Type:

Boolean

Default Value: true

width

Specifies the widget's width.

This option accepts a value of one of the following types.

  • Number
    The width of the widget 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:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }

zoom

The zoom level of the map.

Type:

Number

Default Value: 1

By default, the widget sets the automatically calculated zoom value each time a marker or a route is added to the map. In this case, zoom is set to the maximum value, allowing all markers and routes to be displayed at the same time. Set the autoAdjust option to false to disable this behavior.

Note that if the autoAdjust option is set to true, the zoom level can only be decreased to display all markers and routes. If the current zoom level and center position allow all routes and markers to be displayed on the map, they remain unchanged.

Show Example:
AngularJS
Knockout
jQuery