Icons
Geocode
LBS
Search
Route
Points
Miscellaneous
Index

RouteVectorLayer

The RouteVectorLayer class is the presented layer of a route above the map.
With this class, you can set the route style.

In order to show a route on the map, you should add to the route vector layer the Route object and attach the route vector layer to the map.
You can also use the default route vector layer of the map (you can get the object by the map’s routeVectorLayer property), and just use the map’s showRoute method.


Summary
The RouteVectorLayer class is the presented layer of a route above the map.
With this class, you can set the route style.
The RouteVectorLayer constructor.
Clears the route from the map.
This method also kills the route object.
Returns true if the route is editable, otherwize, returns false.
Returns the route line style.
Shows the route.
Hides the route from the map.
Hides the route animation.
Hides the route flags.
Hides the route maneuvers.
Assigns a route and map to the route vector layer.
Sets the route as editable.
The user can drag the route to a new point to add a new location.
Sets the route line style.
Shows the route animation.
Shows the route flags.
Shows the route maneuvers.

Functions

RouteVectorLayer

RouteVectorLayer()

The RouteVectorLayer constructor.  Creates a new route vector layer instance.

clearRoute

clearRoute()

Clears the route from the map.
This method also kills the route object.

getEditable

Boolean getEditable()

Returns true if the route is editable, otherwize, returns false.

See Also

setEditable

getStyle

LineStyle getStyle()

Returns the route line style.

See Also

setStyle

hide

hide()

Hides the route from the map.

See Also

show

hide

show()

Shows the route.

See Also

show

hideAnimation

show()

Hides the route animation.

See Also

showAnimation

hideFlags

hideFlags()

Hides the route flags.

See Also

showFlags

hideManeuvers

hideManeuvers()

Hides the route maneuvers.

See Also

showManeuvers

init

init(Route route
Map map)

Assigns a route and map to the route vector layer.

Parameters

routeThe route object that holds the route data.
mapThe map the route vector layer should be attached to.

setEditable

setEditable()

Sets the route as editable.
The user can drag the route to a new point to add a new location.

See Also

getEditable

setStyle

setStyle(LineStyle lineStyle)

Sets the route line style.

Parameters

lineStyleThe new route line style.

See Also

getStyle

showAnimation

showAnimation()

Shows the route animation.

See Also

hideAnimation

showFlags

showFlags()

Shows the route flags.

See Also

hideFlags

showManeuvers

showManeuvers()

Shows the route maneuvers.

See Also

hideAnimation

RouteVectorLayer()
The RouteVectorLayer constructor.
init(Route route
Map map)
Assigns a route and map to the route vector layer.
setStyle(LineStyle lineStyle)
Sets the route line style.
LineStyle getStyle()
Returns the route line style.
hide()
Hides the route from the map.
show()
Hides the route animation.
showAnimation()
Shows the route animation.
showManeuvers()
Shows the route maneuvers.
setEditable()
Sets the route as editable.
The user can drag the route to a new point to add a new location.
Boolean getEditable()
Returns true if the route is editable, otherwize, returns false.
clearRoute()
Clears the route from the map.
This method also kills the route object.
Inheritance: EventListener > Route
t.showRoute=function(_object)
Shows a route on the map.
Inheritance: EventListener > Map
This class defines a line style.
t.show =function()
Shows the layer above the map.