# Modules.Map.Polygon

Represents a bounded area on the map.

Availability

4.1.0

9.2.0

Extends

Titanium.Proxy

# Overview

The Polygon object gives you low-level control over polygons that can be added to a Modules.Map.View. A polygon must have its points property set to appear on a map.

Use the Modules.Map.createPolygon method to create a polygon.

# Properties

# fillColor

Availability

4.1.0

9.2.0

fillColor :String

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

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

Default: black

# holes CREATION ONLY

Availability

4.1.0

9.2.0

holes :Array<Array<MapPointType>>

Array of points arrays that define holes in the polygon.

# points CREATION ONLY

Availability

4.1.0

9.2.0

points :Array<MapPointType>

Array of map points making up the polygon. Can also be an array of longitude (index 0), latitude (index 1) touples.

# strokeColor

Availability

4.1.0

9.2.0

strokeColor :String

Color to use for the border of the polygon, 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 polygon.

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

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