Class OracleELocation

Object
   |
   +--OracleELocation

class OracleELocation


This class provides a number of convenient methods for accessing Oracle's eLocation Geocoding and Routing services.
Defined in oracleelocationv3.3.js


Field Summary
<static>  Object ERROR_GEOCODE_FAILED
          Geocoder Error code: Geocoder has encounted internal error.
<static>  Object ERROR_ROUTE_ADDR_INVALID
          Router Error code: One or more input addresses can not be geocoded or the geocoded results might not be accurate.
<static>  Object ERROR_ROUTE_FAILED
          Router Error code: Router has encounted internal error.
<static>  Object ERROR_ROUTE_NOT_FOUND
          Router Error code: Route can not be calculated.
<static>  Object ERROR_UNEXPECTED_SERVER_RESPONSE
          eLocation Error code: eLocation returned an unexpected response.
 
Constructor Summary
OracleELocation(<String> elocURL)
           
 
Method Summary
 void attachEventListenerToRoute(routeId, eventType, eventHandler)
          

Attach event handlers to routes and route segments, such as:

  • OM.event.MouseEvent.MOUSE_CLICK
  • OM.event.MouseEvent.MOUSE_RIGHT_CLICK
  • OM.event.MouseEvent.MOUSE_OVER
  • OM.event.MouseEvent.MOUSE_OUT
The eventHandler function should define a parameter where the actual event will be filled.
 Object batchGeocode(addressArray, <Function> callBack, <Function> errHandler, <Object> mapOptions)
           This method invokes the geocoder on eLocation to obtain the longitude/latitude information for a given Array of addresses.
 void changeRouteStyle(<Array> routeStyles)
          

Updates the draw color/style for already drawn routes on the map.

 void detachEventListenerFromRoute(routeId, eventType, eventHandler)
          

Detach event handlers from routes and route segments, such as:

  • OM.event.MouseEvent.MOUSE_CLICK
  • OM.event.MouseEvent.MOUSE_RIGHT_CLICK
  • OM.event.MouseEvent.MOUSE_OVER
  • OM.event.MouseEvent.MOUSE_OUT

 void geocode(<Object> address, <Function> callBack, <Function> errHandler, <Object> mapOptions)
           This method invokes the geocoder on eLocation to obtain the longitude/latitude information for a given street address.
 void getDirections(<Array> routes, <Function> callBack, <Function> errHandler, <Object> routeOptions, <Object> mapOptions)
          

This method invokes the eLocation routing engine to caculate route and/or driving directions between destinations.

 void removeRoutesFromMap(<Array> routeArray)
           Removes routes drawn on the map.
 void setInfoTip(featureId, <String> infoTipTxt)
           Sets specific infoTip on drawn routes

Field Detail

ERROR_GEOCODE_FAILED

<static> Object ERROR_GEOCODE_FAILED

ERROR_ROUTE_ADDR_INVALID

<static> Object ERROR_ROUTE_ADDR_INVALID

ERROR_ROUTE_FAILED

<static> Object ERROR_ROUTE_FAILED

ERROR_ROUTE_NOT_FOUND

<static> Object ERROR_ROUTE_NOT_FOUND

ERROR_UNEXPECTED_SERVER_RESPONSE

<static> Object ERROR_UNEXPECTED_SERVER_RESPONSE

Constructor Detail

OracleELocation

OracleELocation(<String> elocURL)

Method Detail

attachEventListenerToRoute

void attachEventListenerToRoute(routeId, eventType, eventHandler)

batchGeocode

Object batchGeocode(addressArray, <Function> callBack, <Function> errHandler, <Object> mapOptions)

changeRouteStyle

void changeRouteStyle(<Array> routeStyles)

detachEventListenerFromRoute

void detachEventListenerFromRoute(routeId, eventType, eventHandler)

geocode

void geocode(<Object> address, <Function> callBack, <Function> errHandler, <Object> mapOptions)

getDirections

void getDirections(<Array> routes, <Function> callBack, <Function> errHandler, <Object> routeOptions, <Object> mapOptions)

removeRoutesFromMap

void removeRoutesFromMap(<Array> routeArray)

setInfoTip

void setInfoTip(featureId, <String> infoTipTxt)


Documentation generated by JSDoc on Wed Aug 23 15:07:41 2017