RouteBuilder
Summary
Central Route component interface for an application layer.
Provides interface to route commands and binds route events to RouteRenderer
Constructor
aeris.maps.gmaps.route.RouteBuilder
Syntax
aeris.maps.gmaps.route.RouteBuilder
-
opt_options
Summary
Parameters:
-
opt_options
Object=-
routeRenderer
RouteRenderer= -
commandManger
CommandManager= -
route
Route -
styles
Object=See RouteRenderer for style options.
-
AddWaypointCommand
Function= -
MoveWaypointCommand
Function= -
RemoveWaypointCommand
Function= -
ResetRouteCommand
Function= -
AppendReverseRouteCommand
Function=
-
Item Index
Methods
Properties
Methods
addWaypoint
Syntax
Summary
Add a waypoint to the route.
Parameters:
Returns:
A promise to add the waypoint.
addWaypointAt
Syntax
Summary
Insert a waypoint into to the route at a specified index.
Returns:
A promise to add the waypoint.
delegateRouteEvents
Syntax
delegateRouteEvents
-
opt_events
-
opt_ctx
Summary
Delegates events to this.route_
.
eraseWaypoint_
Syntax
eraseWaypoint_
-
waypoint
-
indexOfWaypointInRoute
Summary
Remove a waypoint view from the map.
moveWaypoint
Syntax
Summary
Change the position of a waypoint.
Returns:
redrawRoute_
Syntax
redrawRoute_
-
waypoints
Summary
removeWaypoint
Syntax
Summary
Parameters:
-
waypoint
Waypoint
Returns:
A promise to remove the waypoint.
renderWaypoint_
Syntax
renderWaypoint_
-
waypoint
Summary
Render a waypoint.
Parameters:
-
waypoint
Waypoint
resetRoute
Syntax
Summary
Reset all waypoints in a route.
Returns:
A promise to reset the route.
undelegateEvents
Syntax
undelegateEvents
()
Summary
Undelegate all events bound by this RouteBuilder.
undelegateRouteEvents
Syntax
undelegateRouteEvents
()
Summary
Undelegate events bound to this.route_
Properties
AddWaypointCommand_
Syntax
AddWaypointCommand_
Function Constructor.
private
Summary
AppendReverseRouteCommand_
Syntax
AppendReverseRouteCommand_
Function Constructor.
private
Summary
followDirections
Syntax
followDirections
Boolean
Summary
Whether added waypoints should follow directions.
MoveWaypointCommand_
Syntax
MoveWaypointCommand_
Function Constructor.
private
Summary
RemoveWaypointCommand_
Syntax
RemoveWaypointCommand_
Function Constructor.
private
Summary
ResetRouteCommand_
Syntax
ResetRouteCommand_
Function Constructor.
private
Summary
routeEvents_
Syntax
Summary
Hash of event listeners bound to the {aeris.maps.gmaps.route.Route}
routeRenderer_
Syntax
Summary
The {aeris.maps.gmaps.route.RouteRenderer} used by the builder to render route view elements.
travelMode
Syntax
travelMode
aeris.maps.gmaps.route.Waypoint.travelMode
Summary
Travel mode to set on new waypoints.
Events
command
Syntax
command
Summary
A command has been executed, undone, or redone.
command:execute
Syntax
command:execute
Summary
command:redo
Syntax
command:redo
Summary
command:undo
Syntax
command:undo
Summary
path:click
Syntax
path:click
Summary
Event Payload:
-
latLon
aeris.maps.LatLon -
marker
aeris.maps.gmaps.route.WaypointWaypoint whose path was clicked.
waypoint:click
Syntax
waypoint:click
Summary
Event Payload:
-
latLon
aeris.maps.LatLon -
marker
aeris.maps.gmaps.route.Waypoint
waypoint:dragend
Syntax
waypoint:dragend
Summary
Event Payload:
-
latLon
aeris.maps.LatLon -
marker
aeris.maps.gmaps.route.Waypoint