Options
| Name | Description |
|---|---|
| accessKey |
Specifies the shortcut key that sets focus on the UI component. |
| activeStateEnabled |
Specifies whether the UI component changes its visual state as a result of user interaction. |
| apiKey |
Keys to authenticate the component within map providers. |
| 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. |
| 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. |
| providerConfig |
A provider configuration object. |
| 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
Methods
| Name | Description |
|---|---|
| addMarker(markerOptions) |
Adds a marker to the map. |
| addRoute(routeOptions) |
Adds a route to the map. |
| beginUpdate() |
Postpones rendering that can negatively affect performance 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() |
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically. |
| resetOption(optionName) |
Resets a property to its default value. |
Events
| 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. |
Types
| Name | Description |
|---|---|
| ClickEvent |
The type of the click event handler's argument. |
| DisposingEvent |
The type of the disposing event handler's argument. |
| InitializedEvent |
The type of the initialized event handler's argument. |
| MapProvider |
The name of the current map data provider. |
| MapType |
The type of a map to display. |
| MarkerAddedEvent |
The type of the markerAdded event handler's argument. |
| MarkerRemovedEvent |
The type of the markerRemoved event handler's argument. |
| OptionChangedEvent |
The type of the optionChanged event handler's argument. |
| ReadyEvent |
The type of the ready event handler's argument. |
| RouteAddedEvent |
The type of the routeAdded event handler's argument. |
| RouteMode |
Specifies a transportation mode to be used in the displayed route. |
| RouteRemovedEvent |
The type of the routeRemoved event handler's argument. |