Titanium SDK # Modules.Map.Circle
Represents a bounded area on the map.
4.1.0
4.1.0
9.2.0# Overview
The Circle object gives you low-level control over circles that can be added to a
Modules.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.
# Properties
# apiName READONLY
4.1.0 4.1.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.
# blendMode CREATION ONLY
12.0.0 12.0.0The blend mode to apply to the overlay.
Use one of the Ti.UI.BLEND_MODE_* constants!
# bubbleParent
4.1.0 4.1.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
# center CREATION ONLY
4.1.0 4.1.0 9.2.0An object with longitude and latitude values. Can also be an array with longitude (index 0), latitude (index 1) touples.
# fillColor
4.1.0 4.1.0 9.2.0Color 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
# lifecycleContainer
4.1.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.
# opacity
4.1.0 4.1.0 9.2.0Opacity of this map circle, from 0.0 (transparent) to 1.0 (opaque).
Default: 1.0 (opaque)
# radius CREATION ONLY
4.1.0 4.1.0 9.2.0The radius of the circle, specified in meters. It should be zero or greater.
# strokeColor
4.1.0 4.1.0 9.2.0Color 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
# strokeWidth
4.1.0 4.1.0 9.2.0Line width in pixels to use when drawing the circle.
Default: 10
# touchEnabled
6.2.0 6.2.0 9.2.0Determines whether view should receive touch events.
Default: true
# zIndex CREATION ONLY
4.1.0The order (depth) in which to display the circles.
For iOS, the circles are drawn in the order in which they are added.
# Methods
# addEventListener
4.1.0 4.1.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
4.1.0 4.1.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
4.1.0 4.1.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
4.1.0 4.1.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