MapAPI 1.4

Classes

Classes

IWAbstractAddress
IWAccessFilter
IWAddress
IWAddressLocationInputHandler
IWAddressString
IWAlignment
IWBounds
IWButton
IWClassMarker
IWClonable
IWClusteredOverlayLayer
IWClusteringAlgorithm
IWClusteringUtils
IWCollapsiblePanelControl
IWControl
IWCoordinate
IWCoordinateLocationInputHandler
IWCopyrightChangeEvent
IWCopyrightControl
IWDraggable
IWElectronicHorizon
IWElectronicHorizonMatchEvent
IWElectronicHorizonRecalculationEvent
IWEventListener
IWEventManager
IWGeocoderClient
IWGeocodingEvent
IWGeocodingResult
IWGeoJSONStyle
IWGeoJSONStyleFromProperties
IWGeoJSONStyleMultiColor
IWGeoJSONStyleUniColor
IWGeoJSONUtils
IWGeoLocationUtils
IWGeometryFilter
IWGraphics
IWGraphicsRenderer
IWIcon
IWIconManager
IWInfoBalloon
IWKeyboardAdapter
IWKeyboardEvent
IWKMeansClustering
IWLabel
IWLanguage
IWLanguageCacheManager
IWLanguageChangeEvent
IWLanguagePack
IWLayer
IWLayerGroup
IWLayerInfoEvent
IWLayerInfoManager
IWLayerInterface
IWLayout
IWLayoutManager
IWLoader
IWLocationInputHandler
IWLocationSearchControl
IWManeuvers
IWMap
IWMapAction
IWMapActionMove
IWMapActionTypeChange
IWMapActionZoom
IWMapCenterEvent
IWMapControlChangeEvent
IWMapElement
IWMapOptions
IWMapRenderer
IWMaptripRemote
IWMapType
IWMapTypeAvailabilityChangeEvent
IWMapTypeChangeEvent
IWMapTypesChangeEvent
IWMapTypeUtils
IWMarker
IWMarkerFactory
IWMeasuringControl
IWMeasuringEvent
IWMeasuringInfoWindowControl
IWMouseAdapter
IWMouseEvent
IWMouseWheelAdapter
IWMouseWheelEvent
IWMultiControl
IWMultiLanguageSupport
IWMultiLanguageSupportEvent
IWNavigationControl
IWNodeElement
IWOlr
IWOlrUtils
IWOverlay
IWOverlayLayer
IWOverlayManager
IWOverlaySelectionControl
IWOverviewMapControl
IWPanelControl
IWParallelProjection
IWPoiContentFormatterEngine
IWPoint
IWPoiUtils
IWPolygonUtils
IWProjection
IWProjectionClient
IWProjectionEvent
IWProjectionType
IWProjectionUtils
IWRange
IWRasterBasedClustering
IWRequestFormatter
IWRequestLayer
IWRequestLayerEvent
IWResizeEvent
IWReverseGeocodingEvent
IWReverseGeocodingResult
IWRoute
IWRouteEntry
IWRouteFormatter
IWRouteFormatter
IWRouteOptions
IWRoutingClient
IWRoutingControl
IWRoutingControl
IWRoutingManager
IWRoutingUtils
IWScalarControl
IWScaleDependentIcon
IWSelectableMap
IWSelection
IWSelectionManager
IWServerConfig
IWShape
IWSimpleMarker
IWSimpleRouteFormatter
IWSize
IWSlideInMenuControl
IWSliderControl
IWSortableList
IWSVGToolbarControl
IWTabbedPanelControl
IWTilesRemovalStrategy
IWTilesRemovalStrategyHarsh
IWTilesRemovalStrategyHeuristicCached
IWTilesRemovalStrategyNavigationDistance
IWTooltip
IWTouchUtils
IWTraffic
IWTreeNode
IWTreeNodeClickedEvent
IWTreeView
IWTruckAttributes
IWVEUtils
IWViaPoint
IWWindowControl
IWWindowOverlay
IWWindowOverlayManager
IWWMTSParser
IWWMTSUtils
IWZoomButtonControl
IWZoomEvent

Events

onaddlayer

The addlayer event is fired when a layer is added to the map.

The event has a single property named layer (containing the IWLayerInterface object).

Register an event listener with IWEventManager.addListener(yourMap, 'onaddlayer', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

oncalculateroutestart

The oncalculateroutestart event is fired when the route calculation has started.

Register an event listener with IWEventManager.addListener(IWRoutingManager, 'oncalculateroutestart', yourHandlerMethod()); to receive this event.

Returns:
Type
void

onCenter

The onCenter event is fired after the map has been centered.

Register an event listener with IWEventManager.addListener(yourMapObject, 'oncenter', yourHandlerMethod(event)); to receive the IWMapCenterEvent.

Parameters:
Name Type Description
event IWMapCenterEvent the map centered event
Returns:
Type
void

onclick

The onclick event is fired when the mouse button is clicked.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onclick', yourHandlerMethod(event)); to receive the IWMouseEvent.

Parameters:
Name Type Description
event IWMouseEvent the mouse event
Returns:
Type
void

onCloseEnd

The onCloseEnd event is fired before the window control is hide.

Register an event listener with IWEventManager.addListener(theWindowControl, 'oncloseend', yourHandlerMethod()); to receive the event.

Returns:
Type
void

onCloseStart

The onCloseStart event is fired before the window control is hide.

Register an event listener with IWEventManager.addListener(theWindowControl, 'onclosestart', yourHandlerMethod()); to receive the event.

Returns:
Type
void

onclosestart

The onclosestart event is fired before the slide-in menu is closed.

Register an event listener with IWEventManager.addListener(theSlideInMenu, 'onclosestart', yourHandlerMethod(event)); to receive the event.

Returns:
Type
void

onconfirmpage

The onconfirmpage event is fired when the selection window of the geocoding results is shown

Register an event listener with IWEventManager.addListener(theRoutingControl, 'onconfirmpage', yourHandlerMethod(event)); to receive the event.

Parameters:
Name Type Description
event Object event
Returns:
Type
void

onconfirmpage

The onconfirmpage event is fired when the selection window of the geocoding results is shown

Register an event listener with IWEventManager.addListener(theRoutingControl, 'onconfirmpage', yourHandlerMethod(event)); to receive the event.

Parameters:
Name Type Description
event Object event
Returns:
Type
void

onCopyrightChange

The onCopyrightChange event is fired after the copyright text has been changed.

Register an event listener with IWEventManager.addListener(yourMapObject, 'oncopyrightchange', yourHandlerMethod(event)); to receive the IWCoyprightChangedEvent.

Parameters:
Name Type Description
event IWCopyrightChangeEvent the event
Returns:
Type
void

onDataReceive

The onDataReceive event is fired when data is received.

Register an event listener with IWEventManager.addListener(map.getLayerInfoManager(), 'ondatareceive', yourHandlerMethod(event)); to receive the event.

Parameters:
Name Type Description
event IWLayerInfoEvent the info event
Returns:
Type
void

onDataReceive

The onDataReceive event is fired when data is received.

Register an event listener with IWEventManager.addListener(myReqLayer, 'ondatareceive', yourHandlerMethod(event)); to receive the event.

Parameters:
Name Type Description
event IWLayerInfoEvent the info event
Returns:
Type
void

ondblclick

The ondblclick event is fired when the user double clicks with the mouse.

Register an event listener with IWEventManager.addListener(yourMapObject, 'ondblclick', yourHandlerMethod(event)); to receive the IWMouseEvent.

Parameters:
Name Type Description
event IWMouseEvent the mouse event
Returns:
Type
void

ondestinationset

The ondestinationset event is fired when a new destination address is set.

Register an event listener with IWEventManager.addListener(IWRoutingManager, 'ondestinationset', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onDistanceChange

The onDistanceChange event is fired after the distance has been changed.

Register an event listener with IWEventManager.addListener(theMeasuringSegment, 'ondistancechange', yourHandlerMethod(event)); to receive the event.

Returns:
Type
void

onDrag

The onDrag event is fired when the object is dragged.

Register an event listener with IWEventManager.addListener(draggableObject, 'ondrag', yourHandlerMethod(event)); to recieve the event.

Parameters:
Name Type Description
event IWMouseEvent the on drag event
Returns:
Type
void

onDragEnd

The onDragEnd event is fired after the object is dragged.

Register an event listener with IWEventManager.addListener(draggableObject, 'ondragend', yourHandlerMethod(event)); to recieve the event.

Parameters:
Name Type Description
event IWMouseEvent the event
Returns:
Type
void

onDragStart

The onDragStart event is fired before the object is dragged.

Register an event listener with IWEventManager.addListener(draggableObject, 'ondragstart', yourHandlerMethod(event)); to recieve the IWMouseEvent.

Parameters:
Name Type Description
event IWMouseEvent the event
Returns:
Type
void

onerror

The error event is fired when a geolocation attempt resulted in an error.

The event object has one property: code is a constant describing the error as defined in https://developer.mozilla.org/en-US/docs/Web/API/PositionError.

Register an event listener with IWEventManager.addListener(IWGeoLocationUtils, 'onerror', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onFormatNode

The onFormatNode event is fired before a node is appended to the tree.

Register an event listener with IWEventManager.addListener(yourTreeview, 'onformatnode', yourHandlerMethod(event)); to receive the IWFormatNodeEvent.

Parameters:
Name Type Description
event IWFormatNodeEvent the format node event
Returns:
Type
void

ongeocode

The geocode event is fired when the address is geocoded.

Register an event listener with IWEventManager.addListener(theGeocoderClient, 'ongeocode', yourHandlerMethod(event)); to receive the event.

Parameters:
Name Type Description
event IWGeocodingEvent the geocoding event
Returns:
Type
void

oninitialize

The initialize event is fired when the map has been loaded the first time.

Register an event listener with IWEventManager.addListener(yourMapObject, 'oninitialize', yourHandlerMethod(event)); to receive the event.

Parameters:
Name Type Description
event object the map initialized event
Returns:
Type
void

oninitialize

The oninitialize event is triggered when the control is initialized.

Register an event listener with IWEventManager.addListener(theRoutingControl, 'oninitialize', yourHandlerMethod(event)); to receive the event.

Returns:
Type
void

oninitialize

The oninitialize event is triggered when the control is initialized.

Register an event listener with IWEventManager.addListener(theRoutingControl, 'oninitialize', yourHandlerMethod(event)); to receive the event.

Returns:
Type
void

oninputchecked

The oninputchecked event is fired whenever the input addresses for start, destination and interstations have been checked.

Register an event listener with IWEventManager.addListener(IWRoutingManager, 'oninputchecked', yourHandlerMethod(event)); to receive this event.

Event properties:
String addresses - an object with lists of addresses for start, destionation and every interstation
Parameters:
Name Type Description
event Object an object with properties as described above
Returns:
Type
void

oninterstationset

The oninterstationset event is fired when one or more interstations are set.

Register an event listener with IWEventManager.addListener(IWRoutingManager, 'oninterstationset', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onkeydown

The onkeydown event is fired when a key is pressed down.

Register an event listener with IWEventManager.addListener(yourKeyboardAdapter, 'onkeydown', yourHandlerMethod(event)); to receive this event.

Parameters:
Type Description
IWKeyboardEvent
Returns:
Type
void

onkeypress

The onkeypress event is fired when a key is pressed.

Register an event listener with IWEventManager.addListener(yourKeyboardAdapter, 'onkeypress', yourHandlerMethod(event)); to receive this event.

Parameters:
Type Description
IWKeyboardEvent
Returns:
Type
void

onkeyup

The onkeyup event is fired when a key is released.

Register an event listener with IWEventManager.addListener(yourKeyboardAdapter, 'onkeyup', yourHandlerMethod(event)); to receive this event.

Parameters:
Type Description
IWKeyboardEvent
Returns:
Type
void

onLanguageChange

The onLanguageChange event is fired after the language has been changed.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onlanguagechange', yourHandlerMethod(event)); to receive the IWLanguageChangeEvent.

Parameters:
Name Type Description
event IWLanguageChangeEvent the event
Returns:
Type
void

onLanguagePackError

The onlanguagepackerror event is fired if the requested language pack failed to be loaded.

Register an event listener with IWEventManager.addListener(yourMultiLanguageSupportObject, 'onlanguagepackerror', yourHandlerMethod(event)); to receive the IWMultiLanguageSupportEvent.

Parameters:
Name Type Description
event Object status code (event.status) and status text (event.statusText)
Returns:
Type
void

onLanguagePackLoad

The onlanguagepackload event is fired after the requested language pack has been loaded.

Register an event listener with IWEventManager.addListener(yourMultiLanguageSupportObject, 'onlanguagepackload', yourHandlerMethod(event)); to receive the IWMultiLanguageSupportEvent.

Parameters:
Name Type Description
event IWMultiLanguageSupportEvent the language support event
Returns:
Type
void

onlocationfound

The locationfound event is fired when a location containing an address and a coordinate is available.

The event object has these properties:

Property Description Type
coordinate The location IWCoordinate
accuracy The accuracy of the coordinate (in meters) number
distance The distance of the location and the found address (in meters), or 0 if no address was found number
address The nearest address to the location IWAddress

Register an event listener with IWEventManager.addListener(IWGeoLocationUtils, 'onlocationfound', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onlocationfound

The onlocationfound event is fired when a location for a user input was found.

Register an event listener with IWEventManager.addListener(yourControl, 'onlocationfound', yourHandlerMethod(event)); to receive the onlocationfound.

Event properties:
The event always contains a coordinate and an accuracy. The result depends on the type of input, i.e. the input handler used to determine the location. For the default handlers these values are returned:
  • Locate button clicked: coordinate (the location), accuracy (accuracy of the location), address (the next address to this location), distance (between the location and the address)
  • Address string entered: coordinate, accuracy (always 0), distance (always 0), address (the geocoded input)
  • Coordinate entered: coordinate, accuracy (always 0)
Returns:
Type
void

onMapControlChange

The onMapControlChange event is fired after the map control has been changed.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onmapcontrolchange', yourHandlerMethod(event)); to receive the IWMapControlChangeEvent.

Parameters:
Name Type Description
event IWMapControlChangeEvent the event
Returns:
Type
void

onMapTypeAvailabilityChange

The onMapTypeAvailabilityChange event is fired after the availability of a map type has been changed.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onmaptypeavailabilitychange', yourHandlerMethod(event)); to receive the IWMapTypesChangeEvent.

Parameters:
Name Type Description
event IWMapTypeAvailabilityChangeEvent the event
Returns:
Type
void

onMapTypeChange

The onMapTypeChange event is fired after the map type has been changed.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onmaptypechange', yourHandlerMethod(event)); to receive the IWMapTypeChangeEvent.

Parameters:
Name Type Description
event IWMapTypeChangeEvent the event
Returns:
Type
void

onMapTypeChangeStart

The onMapTypeChangeStart event is fired before the map type changed.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onmaptypechangestart', yourHandlerMethod(event)); to receive the IWMapTypeChangeEvent.

Parameters:
Name Type Description
event IWMapTypeChangeEvent the event
Returns:
Type
void

onMapTypesChange

The onMapTypesChange event is fired after the map types have been changed.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onmaptypeschange', yourHandlerMethod(event)); to receive the IWMapTypesChangeEvent.

Parameters:
Name Type Description
event IWMapTypesChangeEvent the event
Returns:
Type
void

onmoduleload

The onmoduleload event is fired when a module is loaded.

Event properties: name: the name of the module

Register an event listener with IWEventManager.addListener(IWLoader, 'onmoduleload', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onMouseDown

The onMouseDown event is fired when the mouse button is pressed.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onmousedown', yourHandlerMethod(event)); to receive the IWMouseEvent.

Parameters:
Name Type Description
event IWMouseEvent the mouse event
Returns:
Type
void

onMouseStop

The onMouseStop event is fired when the mouse has been stopped.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onmousestop', yourHandlerMethod(event)); to receive the IWMouseEvent.

Parameters:
Name Type Description
event IWMouseEvent the mouse event
Returns:
Type
void

onmouseup

The onmouseup event is fired when the mouse button is released.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onmouseup', yourHandlerMethod(event)); to receive the IWMouseEvent.

Parameters:
Name Type Description
event IWMouseEvent the mouse event
Returns:
Type
void

onmousewheel

The onmousewheel event is fired when the mouse wheel is used in the specified container.

Register an event listener with IWEventManager.addListener(yourMouseWheelAdapter, 'onmousewheel', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onMove

The onMove event is continuously fired while the map is moved around.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onmove', yourHandlerMethod(event)); to receive the IWMoveEvent.

Parameters:
Name Type Description
event the move event
Returns:
Type
void

onMoveEnd

The onMoveEnd event is fired when the map has been moved.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onmoveend', yourHandlerMethod(event)); to receive the IWMoveEvent.

Parameters:
Name Type Description
event the move event
Returns:
Type
void

onMoveStart

The onMoveStart event is fired before the map is moved.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onmovestart', yourHandlerMethod(event)); to receive the event object.

Parameters:
Name Type Description
event object the move event
Returns:
Type
void

onNodeClick

The onNodeClick event is fired after a node has been clicked.

Register an event listener with IWEventManager.addListener(yourTreeview, 'onnodeclick', yourHandlerMethod(event)); to receive the IWTreeNodeClickedEvent.

Parameters:
Name Type Description
event IWTreeNodeClickedEvent the node click event
Returns:
Type
void

onOpenEnd

The onOpenEnd is fired after the window control is shown.

Register an event listener with IWEventManager.addListener(theWindowControl, 'onopenend', yourHandlerMethod()); to receive the event.

Returns:
Type
void

onOpenStart

The onOpenStart event is fired before the window control is shown.

Register an event listener with IWEventManager.addListener(theWindowControl, 'onopenstart', yourHandlerMethod()); to receive the event.

Returns:
Type
void

onopenstart

The onopenstart event is fired before the slide-in menu is opened.

Register an event listener with IWEventManager.addListener(theSlideInMenu, 'onopenstart', yourHandlerMethod(event)); to receive the event.

Returns:
Type
void

onoptionsset

The onoptionsset event is fired when new route options are set.

Register an event listener with IWEventManager.addListener(IWRoutingManager, 'onoptionsset', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onorderchange

The onorderchange event is fired when the list is reordered by the user.

Register an event listener with IWEventManager.addListener(yourSortableList, 'onorderchange', yourHandlerMethod(event)); to receive this event.

Properties: items an array of list items in the new order

Parameters:
Name Type Description
event object an object containing properties as described above
Returns:
Type
void

onoverlayinvisible

The onoverlayinvisible event is fired when the overlays are not rendered because of e.g. an optical zoom.

Register an event listener with IWEventManager.addListener(yourMap, 'onoverlayinvisible', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onoverlayvisible

The onoverlayvisible event is fired when the overlays are rendered visible because there is a valid projection and no optical zoom in progress.

Register an event listener with IWEventManager.addListener(yourMap, 'onoverlayvisible', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onpoiinitialize

The poiinitialize event is fired when a POI catalogue is initialized. You can use this to initialize a POI selection control etc.

Register an event listener with IWEventManager.addListener(IWPoiUtils, 'onpoiinitialize', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onPositionChange

The onPositionChange event is fired after the coordinate of the overlay object has been changed.

Register an event listener with IWEventManager.addListener(overlayObject, 'onpositionchange', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onpositionchange

The positionchange event is fired when a new position is available.

The event object has two properties: coordinate is an IWCoordinate and accuracy the radius in meter.

Register an event listener with IWEventManager.addListener(IWGeoLocationUtils, 'onpositionchange', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onprojection

Is fired when the given coordinate is project to the other projection.

Register an event listener with IWEventManager.addListener(yourProjectionClient, 'onprojection', yourHandlerMethod(event)); to receive this events.

Parameters:
Name Type Description
event IWProjection
Returns:
Type
void

onProjectionInitialize

The onProjectionInitialize event is fired after the projection for the current map type has been initialized.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onprojectioninitialize', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onProjectionInvalid

The onProjectionInvalid event is fired before the projection for the current map type is loaded.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onprojectioninvalid', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onredraw

The onredraw event is triggered on GUI changes. This happens when a collapsed section is shown, an interstation is added or removed, the driving directions are displayed and so on. The event has a property action with the cause of the event.

Register an event listener with IWEventManager.addListener(theRoutingControl, 'onredraw', yourHandlerMethod(event)); to receive the event.

Parameters:
Name Type Description
event Object
Returns:
Type
void

onredraw

The onredraw event is triggered on GUI changes. This happens when a collapsed section is shown, an interstation is added or removed, the driving directions are displayed and so on. The event has a property action with the cause of the event.

Register an event listener with IWEventManager.addListener(theRoutingControl, 'onredraw', yourHandlerMethod(event)); to receive the event.

Parameters:
Name Type Description
event Object
Returns:
Type
void

onRedrawEnd

The onRedrawEnd event is fired after the overlay has been redrawed.

Register an event listener with IWEventManager.addListener(overlayObject, 'onredrawend', yourHandlerMethod()); to receive this event.

Notice that no event object will be passed through the handler method.

Returns:
Type
void

onRedrawStart

The onRedrawStart event is fired before the overlay is redrawed.

Register an event listener with IWEventManager.addListener(overlayObject, 'onredrawstart', yourHandlerMethod()); to receive this event.

Notice that no event object will be passed through the handler method.

Returns:
Type
void

onRegister

The onRegister event is fired when an event is registered.

Event is used internal, use with caution!

Parameters:
Name Type Description
event IWRequestLayerEvent the request layer event
Returns:
Type
void

onremove

The onremove is fired when a layer is removed from map.

Register an event listener with IWEventManager.addListener(myLayer, 'onremove', yourHandlerMethod()); to receive the event.

Returns:
Type
void

onremovelayer

The removelayer event is fired when a layer is removed from the map.

The event has a single property named layer (containing the IWLayerInterface object).

Register an event listener with IWEventManager.addListener(yourMap, 'onremovelayer', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onreset

The onreset event is fired when the reset button is pressed.

Register an event listener with IWEventManager.addListener(theMeasuringInfoWindowControl, 'onreset', yourHandlerMethod()); to receive the event.

Returns:
Type
void

onResize

The onResize event is fired after the map has been resized.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onresize', yourHandlerMethod(event)); to receive this event.

Parameters:
Name Type Description
event IWResizeEvent the resize event
Returns:
Type
void

onreversegeocode

The reversegeocode event is fired when the coordinate is matched to addresses.

Register an event listener with IWEventManager.addListener(theRouterClient, 'onreversegeocode', yourHandlerMethod(event)); to receive the event.

Parameters:
Name Type Description
event IWReverseGeocodingEvent the reverse geocoding event
Returns:
Type
void

onRoute

The onRoute event is fired when the route has been calculated.

Register an event listener with IWEventManager.addListener(theRouterClient, 'onroute', yourHandlerMethod(event)); to receive the event.

Parameters:
Name Type Description
event object the routing event
Returns:
Type
void

onroute

The onroute event is fired when a route has been calculated.

Register an event listener with IWEventManager.addListener(IWRoutingManager, 'onroute', yourHandlerMethod(event)); to receive this event.

Event properties:
boolean success - true if a route was calculated, false otherwise
IWBounds bounds - the bounds of the route geometry
IWRoute[] routes - the suggested route and the alternatives
IWRoute route - just the suggested route (for backward compatibility)
object json - the parsed JSON response
string status - a status text
Parameters:
Name Type Description
event Object an object with properties as described above
Returns:
Type
void

onrouteclear

The onrouteclear event is fired when the route is cleared. The difference to onroutehide is that start, destination and interstations not reset in this case ("delete route").

Register an event listener with IWEventManager.addListener(IWRoutingManager, 'onrouteclear', yourHandlerMethod()); to receive this event.

Returns:
Type
void

onroutedragend

The onroutedragend event is fired when a user has finished dragging a route.

Register an event listener with IWEventManager.addListener(IWRoutingManager, 'onroutedragend', yourHandlerMethod()); to receive this event.

Returns:
Type
void

onroutedragstart

The onroutedragstart event is fired when a user starts to drag a route.

Register an event listener with IWEventManager.addListener(IWRoutingManager, 'onroutedragstart', yourHandlerMethod()); to receive this event.

Returns:
Type
void

onroutehide

The onroutehide event is fired when the route is hidden. The difference to onrouteclear is that start, destination and interstations are not reset in this case ("edit route").

Register an event listener with IWEventManager.addListener(IWRoutingManager, 'onroutehide', yourHandlerMethod()); to receive this event.

Returns:
Type
void

onroutehighlight

The onroutehighlight event is fired when the alternative routes are re-drawn to highlight an alternative.

Register an event listener with IWEventManager.addListener(IWRoutingManager, 'onroutehighlight', yourHandlerMethod()); to receive this event.

Returns:
Type
void

onstartset

The onstartset event is fired when a new start address is set.

Register an event listener with IWEventManager.addListener(IWRoutingManager, 'onstartset', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onStateChange

The onStateChange event is fired if the marking of the node has changed.

Register an event listener with IWEventManager.addListener(node, 'onstatechange', yourHandlerMethod()); to receive the event.

Returns:
Type
void

onUnregister

The onUnregister event is fired when an event is unregistered.

Event is used internal, use with caution!

Parameters:
Name Type Description
event IWRequestLayerEvent the request layer event
Returns:
Type
void

onupdate

The update event is fired when properties like URL or hotspot of an icon change.

Register an event listener with IWEventManager.addListener(yourIcon, 'onupdate', yourHandlerMethod(event)); to receive this event.

Returns:
Type
void

onZoom

The onZoom event is fired after the new zoomlevel has been calculated.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onzoom', yourHandlerMethod(event)); to receive the IWZoomEvent.

Parameters:
Name Type Description
event IWZoomEvent the zoom event
Returns:
Type
void

onZoomEnd

The onZoomEnd event is fired after the map has been zoomed.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onzoomend', yourHandlerMethod(event)); to receive the IWZoomEvent.

Parameters:
Name Type Description
event IWZoomEvent the zoom event
Returns:
Type
void

onZoomStart

The onZoomStart event is fired before the map is zoomed.

Register an event listener with IWEventManager.addListener(yourMapObject, 'onzoomstart', yourHandlerMethod(event)); to receive the IWZoomEvent.

Returns:
Type
void

deviceCurrentRoute

Creates a new IWMaptripRemote event to retrieve the current route of the specified device.

devices

Creates a new IWMaptripRemote event to return the devices for a specific order event.

devices

Creates a new IWMaptripRemote event to return the devices of a certain user.

devicesStatus

Creates a new IWMaptripRemote to retrieve the status of the specified devices.

login

Creates a new IWMaptripRemote login event.

logout

Creates a new IWMaptripRemote logout response event.

optimizeSequence

Creates a new IWMaptripRemote Optimize Sequence event.

orders

Creates a new IWMaptripRemote (retrieve) orders event.

permissions

Creates a new IWMaptripRemote event to return the permissions for a specific order.

sendAddress

Creates a new IWMaptripRemote to retrieve the status of the specified devices.

sendReferenceRoute

Creates a new IWMaptripRemote request to send a reference route to one device

fileContents

Creates a new IWOlr file contents event with the contents of a file

fileCreate

Creates a new IWOlr event to confirm the creation of a file on the server

fileDelete

Creates a new IWOlr event to confirm the deletion of a file from the server

fileDrawn

Creates a new IWOlr event triggered after the segments were drawn on the map

fileList

Creates a new IWOlr files event containing the list of files for the current user

login

Creates a new IWOlr login event containing the session id and user information

match

Creates a new IWOlr match event containing the OLR code

segmentAdd

Creates a new IWOlr event to confirm the addition of a segment to a file

segmentChange

Creates a new IWOlr event to confirm the update of a segment in a file

segmentDelete

Creates a new IWOlr event to confirm the deletion of a segment from a file