Modules.Map.Circle
> Modules.Map.Circle

Represents a bounded area on the map.

The Circle object gives you low-level control over circles that can be added to a map view. A circle must have a center property and a radius set to appear on a map.

Use the Modules.Map.createCircle method to create a circle.

  • 4.1.0
  • 4.1.0
  • 4.1.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.Circle
: MapPointTypeCreation-Only
An object with longitude and latitude values. ...

An object with longitude and latitude values. Can also be an array with longitude (index 0), latitude (index 1) touples.

Modules.Map.Circle
: String
Color to use when shading the circle, as a color name or hex triplet. ...

Color to use when shading the circle, as a color name or hex triplet.

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

Default: black

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.Circle
: Number
Opacity of this map circle, from 0.0 (transparent) to 1.0 (opaque). ...

Opacity of this map circle, from 0.0 (transparent) to 1.0 (opaque).

Default: 1.0 (opaque)

  • 4.1.0
  • 6.1.0
  • 6.1.0
Modules.Map.Circle
: NumberCreation-Only
The radius of the circle, specified in meters. ...

The radius of the circle, specified in meters. It should be zero or greater.

Modules.Map.Circle
: String
Color to use for the border of the circle, as a color name or hex triplet. ...

Color to use for the border of the circle, as a color name or hex triplet.

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

Default: black

Modules.Map.Circle
: Number
Line width in pixels to use when drawing the circle. ...

Line width in pixels to use when drawing the circle.

Default: 10

Modules.Map.Circle
: Boolean
Determines whether view should receive touch events. ...

Determines whether view should receive touch events.

Default: true

  • 6.2.0
  • 6.2.0
  • 6.2.0
Modules.Map.Circle
zIndex : NumberCreation-Only

The order (depth) in which to display the circles.

The order (depth) in which to display the circles.

For iOS, the circles are drawn in the order in which they are added.

  • 4.1.0
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.Circle
( ) : MapPointType
Gets the value of the center property. ...

Gets the value of the center property.

Returns

Modules.Map.Circle
( ) : String
Gets the value of the fillColor property. ...

Gets the value of the fillColor property.

Returns

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

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Modules.Map.Circle
( ) : Number
Gets the value of the opacity property. ...

Gets the value of the opacity property.

  • 4.1.0
  • 6.1.0
  • 6.1.0

Returns

  • Number
Modules.Map.Circle
( ) : Number
Gets the value of the radius property. ...

Gets the value of the radius property.

Returns

  • Number
Modules.Map.Circle
( ) : String
Gets the value of the strokeColor property. ...

Gets the value of the strokeColor property.

Returns

  • String
Modules.Map.Circle
( ) : Number
Gets the value of the strokeWidth property. ...

Gets the value of the strokeWidth property.

Returns

  • Number
Modules.Map.Circle
( ) : Boolean
Gets the value of the touchEnabled property. ...

Gets the value of the touchEnabled property.

  • 6.2.0
  • 6.2.0
  • 6.2.0

Returns

  • Boolean
Modules.Map.Circle
( ) : Number
Gets the value of the zIndex property. ...

Gets the value of the zIndex property.

  • 4.1.0

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.Circle
( center )
Sets the value of the center property. ...

Sets the value of the center property.

Parameters

Returns

  • void
Modules.Map.Circle
( fillColor )
Sets the value of the fillColor property. ...

Sets the value of the fillColor property.

Parameters

  • fillColor : String

    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.Circle
( opacity )
Sets the value of the opacity property. ...

Sets the value of the opacity property.

  • 4.1.0
  • 6.1.0
  • 6.1.0

Parameters

  • opacity : Number

    New value for the property.

Returns

  • void
Modules.Map.Circle
( radius )
Sets the value of the radius property. ...

Sets the value of the radius property.

Parameters

  • radius : Number

    New value for the property.

Returns

  • void
Modules.Map.Circle
( strokeColor )
Sets the value of the strokeColor property. ...

Sets the value of the strokeColor property.

Parameters

  • strokeColor : String

    New value for the property.

Returns

  • void
Modules.Map.Circle
( strokeWidth )
Sets the value of the strokeWidth property. ...

Sets the value of the strokeWidth property.

Parameters

  • strokeWidth : Number

    New value for the property.

Returns

  • void
Modules.Map.Circle
( touchEnabled )
Sets the value of the touchEnabled property. ...

Sets the value of the touchEnabled property.

  • 6.2.0
  • 6.2.0
  • 6.2.0

Parameters

  • touchEnabled : Boolean

    New value for the property.

Returns

  • void
Modules.Map.Circle
( zIndex )
Sets the value of the zIndex property. ...

Sets the value of the zIndex property.

  • 4.1.0

Parameters

  • zIndex : Number

    New value for the property.

Returns

  • void