API Docs for: 7.2
Show:

MQA.RoutePlatformService Class

Extends MQA.PlatformService
Module: MQA

MQA.RoutePlatformService class. Base class to connect to platform services routing

Constructor

MQA.RoutePlatformService

(
  • baseURI
  • noProxy
  • noTrim
)

Parameters:

Methods

dragRoute

(
  • options
)

Parameters:

fixPois

(
  • options
)
Object private

fix pois to locations for routing

Parameters:

Returns <Object>

optimizedRoute

(
  • options
)

Parameters:

  • options Object
    • request Object
    • display Object
      • [color] String optional the color of the ribbon
      • [colorAlpha] String optional the color of the alpha of the ribbon
      • [borderWidth] Number optional the width of the route ribbon
      • [draggable] Boolean optional if the route is draggable
      • [draggablepoi] Boolean optional if the route's pois (waypoints) are draggable
      • [dragComplete] Function optional the function to call if the route drag completes, returns the new RouteResult
    • success Function

      the response to call if the route is a success

    • error Function

      the response to call if the route is a failure

restorPois

(
  • options
  • result
)
Object private

restore the pois to the location node of the json result

Parameters:

Returns <Object>

route

(
  • options
)

Parameters:

  • options Object
    • request Object
    • [display] Object optional
      • [color] String optional the color of the ribbon
      • [colorAlpha] String optional the color of the alpha of the ribbon
      • [borderWidth] Number optional the width of the route ribbon
      • [draggable] Boolean optional if the route is draggable
      • [draggablepoi] Boolean optional if the route's pois (waypoints) are draggable
      • [dragComplete] Function optional the function to call if the route drag completes, returns the new RouteResult
    • success Function

      the response to call if the route is a success

    • error Function

      the response to call if the route is a failure

routeMatrix

(
  • options
)

route matrix

Parameters:

  • options Object
    • request Object
    • success Function

      the response to call if the route is a success

    • error Function

      the response to call if the route is a failure

routeShape

(
  • options
)

Parameters:

  • options Object
    • request Object
      • sessionId String
      • mapState MapState
    • success Function

      the response to call if the route is a success

    • error Function

      the response to call if the route is a failure