# Modules.Map.Circle

Represents a bounded area on the map.

Availability

4.1.0

9.2.0

Extends

Titanium.Proxy

# 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

# center CREATION ONLY

Availability

4.1.0

9.2.0

center :MapPointType

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

# fillColor

Availability

4.1.0

9.2.0

fillColor :String

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

# opacity

Availability

4.1.0

9.2.0

opacity :Number

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

Default: 1.0 (opaque)

# radius CREATION ONLY

Availability

4.1.0

9.2.0

radius :Number

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

# strokeColor

Availability

4.1.0

9.2.0

strokeColor :String

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

# strokeWidth

Availability

4.1.0

9.2.0

strokeWidth :Number

Line width in pixels to use when drawing the circle.

Default: 10

# touchEnabled

Availability

6.2.0

9.2.0

touchEnabled :Boolean

Determines whether view should receive touch events.

Default: true

# zIndex CREATION ONLY

Availability

4.1.0

zIndex :Number

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

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