Configuration

An object defining configuration options for the dxMap widget.

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

Type: Boolean
Default Value: true

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.

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.

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'

clickAction

An action performed when the map is clicked.

Type: String|function(e)
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
location: Object
Returns the location of the clicked point on the map (if the 'google' or 'bing' provider is used).
jQueryEvent: jQuery.Event
Returns a jQuery event that caused the action's execution (if a static google provider is used).
Default Value: null

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

Alternatively, you can assign a URL to which the browser will navigate when the map is clicked.

Show Example:
jQuery

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:
jQuery

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

Type: Boolean
Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

Show Example:
jQuery

height

Specifies the height of the widget.

Type: Number
Default Value: 300

The option can hold a value of the following types.

  • numeric - the height of the widget in pixels
  • string - a CSS measurement of the widget height (e.g., "55px", "80%", "auto" and "inherit")
  • function - a function returning the widget height (e.g., height:function(){ return baseHeight - 10 + "%"; })

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

Type: Boolean
Default Value: true

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: "apikey", google: "apikey", googleStatic: "api_key"}.

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

NOTE: The value of this option cannot be changed dynamically.

location

Deprecated

Use the center option instead.

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

markerAddedAction

An action performed after a marker is added to the map.

Type: String|function(e)
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
options: Object
Returns the object that defines the currently added marker in the "markers" array
originalMarker: Object
Returns an original marker object used by the current map provider (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.

Alternatively, you can assign a URL to which the browser will navigate after a marker is added to the map.

Show Example:
jQuery

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.

markerRemovedAction

An action performed after a marker is removed from the map.

Type: String|function(e)
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
options: Object
Returns the object that defines the currently removed marker in the "markers" array.
Default Value: null

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

Alternatively, you can assign a URL to which the browser will navigate after a marker is removed from the map.

Show Example:
jQuery

markers

An array of markers displayed on a map.

Type: Array

An item of the array assigned to the markers option is an object containing the following properties.

  • location (required) - an object, a string, or an array specifying the marker location (see the location option description).
  • tooltip (optional) - takes on an object containing the text and isShown fields. The text field specifies the tooltip text. The isShown field takes on a Boolean value that specifies whether a tooltip is visible by default or not. If the tooltip should be hidden by default, pass the tooltip text directly to the tooltip property.
  • clickAction (optional)- an action performed when the marker is clicked.
  • iconSrc (optional) - a URL pointing to the custom icon to be used for the marker.

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

Show Example:
jQuery

provider

The name of the current map data provider.

Type: String
Default Value: "google"
Accepted Values: 'bing'|'google'|'googleStatic'

Show Example:
jQuery

readyAction

An action that is performed after a map is rendered.

Type: String|function(e)
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
originalMap: Object
Returns the provider's map instance.
Default Value: null

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

Alternatively, you can assign a URL to which the browser will navigate after a map is rendered.

routeAddedAction

An action performed after a route is added to the map.

Type: String|function(e)
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
options: Object
Returns the object that defines the currently added route in the "routes" array.
originalMarker: Object
Returns an original route object used by the current map provider (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.

Alternatively, you can assign a URL to which the browser will navigate after a route is added to the map.

Show Example:
jQuery

routeRemovedAction

An action performed after a route is removed from the map.

Type: String|function(e)
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
options: Object
Returns the object that defines the currently removed route in the "markers" array.
Default Value: null

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

Alternatively, you can assign a URL to which the browser will navigate after a route is removed from the map.

Show Example:
jQuery

routes

An array of routes shown on the map.

Type: Array

An item of the array assigned to the routes option is an object containing the following fields.

  • locations (required)
    Contains an array of locations making up the route.
  • mode (optional)
    Specifies a transportation mode to use in the displayed route. Acceptable values: 'driving' (set by default) and 'walking'.
  • color (optional)
    Specifies the color of the line displaying the route.
  • weight (optional)
    Specifies the thickness of the line displaying the route in pixels.
  • opacity (optional)
    Specifies the opacity of the line displaying the route.
Show Example:
jQuery

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

Type: Boolean
Default Value: false

If you need to switch the display of this DevExtreme component to right-to-left, enable a specifically designed configuration option - rtlEnabled. When this option is set to true, the text flows from right to left, and the layout the component's elements is reversed. To switch the entire application/site to a right-to-left representation, use the static DevExpress.rtlEnabled field.

type

The type of a map to display.

Type: String
Default Value: "roadmap"
Accepted Values: 'hybrid'|'roadmap'

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
Show Example:
jQuery

visible

A Boolean value specifying whether or not the widget is visible.

Type: Boolean
Default Value: true

width

Specifies the width of the widget.

Type: Number
Default Value: 300

The option can hold a value of the following types.

  • numeric - the widget width in pixels
  • string - a CSS measurement of the widget width (e.g., "55px", "80%", "auto" and "inherit")
  • function - the function returning the widget width (e.g., width:function(){ return baseWidth - 10 + "%"; })

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:
jQuery