Titanium SDK # Modules.Map.Route
Represents a path between two or more points of interest.
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
# apiName READONLY
3.2.0 3.2.0 9.2.0The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button.
# bubbleParent
3.1.0 3.2.0 9.2.0Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
# color
3.1.0 3.2.0 9.2.0Color 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
3.2.0 9.2.0The 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
# lifecycleContainer
3.6.0The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
# points CREATION ONLY
3.1.0 3.2.0 9.2.0Array of map points making up the route.
# width
3.1.0 3.2.0 9.2.0Line 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
# Methods
# addEventListener
3.1.0 3.2.0 9.2.0Adds the specified callback as an event listener for the named event.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. |
Returns
- Type
- void
# applyProperties
3.1.0 3.2.0 9.2.0Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
Parameters
| Name | Type | Description |
|---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# fireEvent
3.1.0 3.2.0 9.2.0Fires a synthesized event to any registered listeners.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Returns
- Type
- void
# removeEventListener
3.1.0 3.2.0 9.2.0Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to |
Returns
- Type
- void