Fork me on GitHub
Show:

RouteRenderer

Summary

Create a Google Map extension used for rendering a Route.

Constructor

aeris.maps.gmaps.route.RouteRenderer

Syntax

aeris.maps.gmaps.route.RouteRenderer

(
  • opt_options
)

Summary

Parameters:

  • opt_options Object=
    • path PolylineOptions=

      Options for rendering a path's polyline.

    • offPath PolylineOptions=

      Options for rendering a path's polyline When the path is not following directions. Defaults to the same as a path following directions, but with a strokeColor of '#dd0000' (Crimson Red).

    • waypoint WaypointOptions=

      Options for a rending a waypoint's icon.

    • selectedWaypoint WaypointOptions=

      Options for rendering a selected waypoint's icon. Defaults to the same as a non-selected waypoint, but with a different different color icon.

    • map Map

Methods

bindStylesToWaypointState_

Syntax

bindStylesToWaypointState_

(
  • waypoint
)
private

Summary

Parameters:

delegateEventsForWaypoint_

Syntax

delegateEventsForWaypoint_

(
  • waypoint
)
private

Summary

Parameters:

destroy

Syntax

destroy

()

Summary

Close and clean up the RouteRenderer instance.

drawWaypoint_

Syntax

drawWaypoint_

(
  • waypoint
)
private

Summary

Parameters:

eachWaypoint_

Syntax

eachWaypoint_

(
  • callback
)

Summary

Iterate through waypoints in this.routeViews_.

Parameters:

  • callback Function

    Called with the rendered waypoint.

eraseRoute

Syntax

eraseRoute

(
  • route
)

Summary

Erases a single route from the map

Parameters:

forgetWaypoint_

Syntax

forgetWaypoint_

(
  • waypoint
)
private

Summary

Parameters:

getDefaultStyleOptions_

Syntax

getDefaultStyleOptions_

() Object private

Summary

Returns:

getNormalizedStyleOptions_

Syntax

getNormalizedStyleOptions_

(
  • options
)
Object private

Summary

Parameters:

Returns:

hasMap

Syntax

hasMap

() Boolean

Summary

Returns:

isRememberedWaypoint_

Syntax

isRememberedWaypoint_

(
  • waypoint
)
Boolean private

Summary

Parameters:

Returns:

proxyWaypointEvents_

Syntax

proxyWaypointEvents_

(
  • waypoint
)
private

Summary

Parameters:

rememberWaypoint_

Syntax

rememberWaypoint_

(
  • waypoint
)
private

Summary

Parameters:

renderRoute

Syntax

renderRoute

(
  • route
)

Summary

Render all waypoints in a route.

Parameters:

renderWaypoint

Syntax

renderWaypoint

(
  • waypoint
)

Summary

Render a new Waypoint on the map.

Parameters:

  • waypoint Waypoint

    The Waypoint to be rendered.

setMap

Syntax

setMap

(
  • map
)

Summary

Sets the map on which to render routes, and renders all existing routes on the map.

Parameters:

setStylesForWaypoint_

Syntax

setStylesForWaypoint_

(
  • waypoint
)
private

Summary

Parameters:

Properties

map_

Syntax

map_

?aeris.maps.Map private

Summary

The map on which to render the route.

offPathStyles_

Syntax

offPathStyles_

PolylineOptions protected

Summary

pathStyles_

Syntax

pathStyles_

PolylineOptions protected

Summary

renderedWaypoints_

Syntax

renderedWaypoints_

Array. private

Summary

selectedWaypointStyles_

Syntax

selectedWaypointStyles_

WaypointOptions protected

Summary

waypointStyles_

Syntax

waypointStyles_

WaypointOptions protected

Summary

{Boolean=} draggable Whether to allow drag events on the icon. Defaults to true.

Syntax

{Boolean=} draggable Whether to allow drag events on the icon. Defaults to true.

String=

Summary

{number=} strokeWeight Stroke weight, in pixels. Defaults to 3.

Syntax

{number=} strokeWeight Stroke weight, in pixels. Defaults to 3.

String=

Summary

Events

marker:click

Syntax

marker:click

Summary

Event Payload:

marker:dragend

Syntax

marker:dragend

Summary

Event Payload:

path:click

Syntax

path:click

Summary

Event Payload: