# Modules.Map.Route

Represents a path between two or more points of interest.

Availability
3.1.0
3.2.0
9.2.0

# Overview

The Route object gives you low-level control over routes that can be added to a Modules.Map.View. A route must have its points property set to appear on a map.

Use the Modules.Map.createRoute method to create a route.

# iOS Platform Notes

The addRoute method no longer accepts a dictionary as a parameter. Pass a Modules.Map.Route object instead.

# Android Platform Notes

The parameter points accepts additional the route in format encoded polyline.
https://developers.google.com/maps/documentation/utilities/polylinealgorithm

# Properties

# color

Availability
3.1.0
3.2.0
9.2.0
color :String

Color to use when drawing the route, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

iOS Note: Changing the color of an existing route will only work on iOS 7 and later

Default: black


# level CREATION ONLY

Availability
3.2.0
9.2.0
level :Number

The map level at which to place the route. Available in iOS 7.0 and later.

Specify one of the following levels: OVERLAY_LEVEL_ABOVE_LABELS, OVERLAY_LEVEL_ABOVE_ROADS.

Default: Modules.Map.OVERLAY_LEVEL_ABOVE_LABELS


# points CREATION ONLY

Availability
3.1.0
3.2.0
9.2.0
points :String | Array<MapPointType>

Array of map points making up the route.


# width

Availability
3.1.0
3.2.0
9.2.0
width :Number

Line width in pixels to use when drawing the route.

iOS Note: Changing the width of an existing route will only work on iOS 7 and later

Default: 10