React Map API
The Map is an interactive UI component that displays a geographic map with markers and routes.
See Also
- Set Up DevExtreme: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Props
An object defining configuration properties for the Map UI component.
| Name | Description |
|---|---|
| accessKey | Specifies the shortcut key that sets focus on the UI component. |
| activeStateEnabled | Specifies whether or not the UI component changes its state when interacting with a user. |
| 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. |
| 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. |
| controls | Specifies whether or not map UI component controls are available. |
| 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. |
| focusStateEnabled | Specifies whether the UI component can be focused using keyboard navigation. |
| height | Specifies the UI component's height. |
| 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. |
| 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 function that is executed when any location on the map is clicked or tapped. |
| onDisposing | A function that is executed before the UI component is disposed of. |
| onInitialized | A function used in JavaScript frameworks to save the UI component instance. |
| onMarkerAdded | A function that is executed when a marker is created on the map. |
| onMarkerRemoved | A function that is executed when a marker is removed from the map. |
| onOptionChanged | A function that is executed after a UI component property is changed. |
| onReady | A function that is executed when the map is ready. |
| onRouteAdded | A function that is executed when a route is created on the map. |
| onRouteRemoved | A function that is executed when a route is removed from the map. |
| provider | The name of the current map data provider. |
| routes | An array of routes shown on the map. |
| rtlEnabled | Switches the UI component 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 UI component is visible. |
| width | Specifies the UI component's width. |
| zoom | The map's zoom level. The UI component can change this value if autoAdjust is enabled. |
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Methods
This section describes members used to manipulate a UI component.
| Name | Description |
|---|---|
| addMarker(markerOptions) | Adds a marker to the map. |
| addRoute(routeOptions) | Adds a route to the map. |
| beginUpdate() | Prevents the UI component from refreshing until the endUpdate() method is called. |
| defaultOptions(rule) | Specifies the device-dependent default configuration properties for this component. |
| dispose() | Disposes of all the resources allocated to the Map instance. |
| element() | Gets the root UI component element. |
| endUpdate() | Refreshes the UI component after a call of the beginUpdate() method. |
| focus() | Sets focus on the UI component. |
| getInstance(element) | Gets the instance of a UI component found using its DOM node. |
| instance() | Gets the UI component's instance. Use it to access other methods of the UI component. |
| 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 UI component properties. |
| option(optionName) | Gets the value of a single property. |
| option(optionName, optionValue) | Updates the value of a single property. |
| option(options) | Updates the values of several properties. |
| 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 UI component without reloading data. Call it to update the UI component's markup. |
| resetOption(optionName) | Resets an property to its default value. |
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Events
This section describes events fired by this UI component.
| Name | Description |
|---|---|
| click | Raised when any location on the map is clicked. |
| disposing | Raised before the UI component is disposed of. |
| initialized | Raised only once, after the UI component is initialized. |
| markerAdded | Raised when a marker is created on the map. |
| markerRemoved | Raised when a marker is removed from the map. |
| optionChanged | Raised after a UI component property is changed. |
| ready | Raised when the map is ready. |
| routeAdded | Raised when a route is created on the map. |
| routeRemoved | Raised when a route is removed from the map. |
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
If you have technical questions, please create a support ticket in the DevExpress Support Center.