Modules.Map.Route
> Modules.Map.Route

Represents a path between two or more points of interest.

The Route object gives you low-level control over routes that can be added to a 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.

  • 3.1.0
  • 3.2.0
  • 3.2.0
Defined By

Properties

apiName : Stringreadonly

The name of the API that this proxy corresponds to.

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Button returns Ti.UI.Button.

  • 3.2.0
  • 3.2.0
  • 3.2.0
Indicates if the proxy will bubble an event to its parent. ...

Indicates 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

  • 3.0.0
  • 3.0.0
  • 3.0.0
Modules.Map.Route
: String
Color to use when drawing the route, as a color name or hex triplet. ...

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

Modules.Map.Route
: NumberCreation-Only
The map level at which to place the route. ...

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

Specify one of the following levels: Modules.Map.OVERLAY_LEVEL_ABOVE_LABELS, Modules.Map.OVERLAY_LEVEL_ABOVE_ROADS.

Default: Modules.Map.OVERLAY_LEVEL_ABOVE_LABELS

  • 3.2.0
  • 3.2.0

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

The 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.

  • 3.6.0
Modules.Map.Route
points : MapPointType[]Creation-Only

Array of map points making up the route.

Array of map points making up the route.

Modules.Map.Route
: Number
Line width in pixels to use when drawing the route. ...

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

Defined By

Methods

Adds the specified callback as an event listener for the named event. ...

Adds the specified callback as an event listener for the named event.

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Applies the properties to the proxy. ...

Applies 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.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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

  • void
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Modules.Map.Route
( ) : String
Gets the value of the color property. ...

Gets the value of the color property.

Returns

  • String
Modules.Map.Route
( ) : Number
Gets the value of the level property. ...

Gets the value of the level property.

  • 3.2.0
  • 3.2.0

Returns

  • Number
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Modules.Map.Route
( ) : MapPointType[]
Gets the value of the points property. ...

Gets the value of the points property.

Returns

Modules.Map.Route
( ) : Number
Gets the value of the width property. ...

Gets the value of the width property.

Returns

  • Number
Removes the specified callback as an event listener for the named event. ...

Removes 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 : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Modules.Map.Route
( color )
Sets the value of the color property. ...

Sets the value of the color property.

Parameters

  • color : String

    New value for the property.

Returns

  • void
Modules.Map.Route
( level )
Sets the value of the level property. ...

Sets the value of the level property.

  • 3.2.0
  • 3.2.0

Parameters

  • level : Number

    New value for the property.

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Modules.Map.Route
( points )
Sets the value of the points property. ...

Sets the value of the points property.

Parameters

Returns

  • void
Modules.Map.Route
( width )
Sets the value of the width property. ...

Sets the value of the width property.

Parameters

  • width : Number

    New value for the property.

Returns

  • void