java.lang.Object | |
↳ | com.google.android.gms.maps.model.Polygon |
A polygon on the earth's surface. A polygon can be convex or concave, it may span the 180 meridian and it can have holes that are not filled in. It has the following properties:
Color
.
The default value is black (0xff000000
).JointType
for supported joint types. The default
value is DEFAULT
.null
) or a sequence of PatternItem
objects to
be repeated along the polygon's outline. Available PatternItem
types: Gap
(defined by gap length in pixels), Dash
(defined by stroke width and dash length in
pixels) and Dot
(circular, centered on the polygon's outline, diameter defined by stroke
width in pixels).Color
. The
default value is transparent (0x00000000
). If the polygon geometry is not specified
correctly (see above for Outline and Holes), then no fill will be drawn.Polyline
s, Circle
s, GroundOverlay
s and TileOverlay
s, but
not Marker
s. An overlay with a larger z-index is drawn over overlays with
smaller z-indices. The order of overlays with the same z-index value is arbitrary.
The default is 0.true
, i.e., visible.true
. You can change this value at any time. The default is false
. If this
property is set to true
, your app will receive notifications to the
GoogleMap.OnPolygonClickListener
registered through
setOnPolygonClickListener(GoogleMap.OnPolygonClickListener)
.Object
associated with the polygon. For example, the Object
can contain
data about what the polygon represents. This is easier than storing a separate
Map<Polygon, Object>
. As another example, you can associate a String
ID
corresponding to the ID from a data set. Google Maps Android API neither reads nor writes this
property.
Methods in this class must be called on the Android UI thread. If not, an
IllegalStateException
will be thrown at runtime.
GoogleMap map;
// ... get a map.
// Add a triangle in the Gulf of Guinea
Polygon polygon = map.addPolygon(new PolygonOptions()
.add(new LatLng(0, 0), new LatLng(0, 5), new LatLng(3, 5), new LatLng(0, 0))
.strokeColor(Color.RED)
.fillColor(Color.BLUE));
For more information, read the Shapes developer guide.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Gets the fill color of this polygon.
| |||||||||||
Returns a snapshot of the holes of this polygon at this time .
| |||||||||||
Gets this polygon's id.
| |||||||||||
Returns a snapshot of the vertices of this polygon at this time .
| |||||||||||
Gets the stroke color of this polygon.
| |||||||||||
Gets the stroke joint type used at all vertices of the polygon's outline.
| |||||||||||
Gets the stroke pattern of this polygon's outline.
| |||||||||||
Gets the stroke width of this polygon.
| |||||||||||
Gets the tag for the polygon.
| |||||||||||
Gets the zIndex of this polygon.
| |||||||||||
Gets the clickability of the polygon.
| |||||||||||
Gets whether each segment of the line is drawn as a geodesic or not.
| |||||||||||
Gets the visibility of this polygon.
| |||||||||||
Removes the polygon from the map.
| |||||||||||
Sets the clickability of the polygon.
| |||||||||||
Sets the fill color of this polygon.
| |||||||||||
Sets whether to draw each segment of the line as a geodesic or not.
| |||||||||||
Sets the holes of this polygon.
| |||||||||||
Sets the points of this polygon.
| |||||||||||
Sets the stroke color of this polygon.
| |||||||||||
Sets the joint type for all vertices of the polygon's outline.
| |||||||||||
Sets the stroke pattern of the polygon's outline.
| |||||||||||
Sets the stroke width of this polygon.
| |||||||||||
Sets the tag for the polygon.
| |||||||||||
Sets the visibility of this polygon.
| |||||||||||
Sets the zIndex of this polygon.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Parameters | |
---|---|
other |
Object
|
Returns | |
---|---|
boolean |
Gets the fill color of this polygon.
Returns | |
---|---|
int |
the color in ARGB format. |
Returns a snapshot of the holes of this polygon at this time . The list returned is a copy of the list of holes and so changes to the polygon's holes will not be reflected by this list, nor will changes to this list be reflected by the polygon.
Returns | |
---|---|
List<List<LatLng>> |
Gets this polygon's id. The id will be unique amongst all Polygons on a map.
Returns | |
---|---|
String |
Returns a snapshot of the vertices of this polygon at this time . The list returned is a copy
of the list of vertices and so changes to the polygon's vertices will not be reflected by
this list, nor will changes to this list be reflected by the polygon. To change the vertices
of the polygon, call setPoints(List)
.
Returns | |
---|---|
List<LatLng> |
Gets the stroke color of this polygon.
Returns | |
---|---|
int |
the color in ARGB format. |
Gets the stroke joint type used at all vertices of the polygon's outline. See
JointType
for possible values.
Returns | |
---|---|
int |
the stroke joint type. |
Gets the stroke pattern of this polygon's outline.
Returns | |
---|---|
List<PatternItem> |
the stroke pattern. |
Gets the stroke width of this polygon.
Returns | |
---|---|
float |
the width in screen pixels. |
Gets the tag for the polygon.
Returns | |
---|---|
Object |
the tag if a tag was set with setTag ; null if no tag has been set.
|
Gets the zIndex of this polygon.
Returns | |
---|---|
float |
the zIndex of the polygon. |
Returns | |
---|---|
int |
Gets the clickability of the polygon. If the polygon is clickable, your app
will receive notifications to the GoogleMap.OnPolygonClickListener
when the
user clicks the polygon. The event listener is registered through
setOnPolygonClickListener(GoogleMap.OnPolygonClickListener)
.
Returns | |
---|---|
boolean |
true if the polygon is clickable; otherwise, returns false .
|
Gets whether each segment of the line is drawn as a geodesic or not.
Returns | |
---|---|
boolean |
true if each segment is drawn as a geodesic; false if each segment is
drawn as a straight line on the Mercator projection.
|
Gets the visibility of this polygon.
Returns | |
---|---|
boolean |
this polygon visibility. |
Removes the polygon from the map. After a polygon has been removed, the behavior of all its methods is undefined.
Sets the clickability of the polygon. If the polygon is clickable, your app will receive
notifications to the GoogleMap.OnPolygonClickListener
when the user clicks the
polygon. The event listener is registered through
setOnPolygonClickListener(GoogleMap.OnPolygonClickListener)
.
Parameters | |
---|---|
clickable |
boolean :
New clickability setting for the polygon.
|
Sets the fill color of this polygon.
Parameters | |
---|---|
color |
int :
the color in ARGB format
|
Sets whether to draw each segment of the line as a geodesic or not.
Parameters | |
---|---|
geodesic |
boolean :
if true , then each segment is drawn as a geodesic; if false ,
each segment is drawn as a straight line on the Mercator projection.
|
Sets the holes of this polygon. This method will take a copy of the holes, so further
mutations to holes
will have no effect on this polygon.
Parameters | |
---|---|
holes |
List :
an list of holes, where a hole is an list of LatLng s.
|
Sets the points of this polygon. This method will take a copy of the points, so further
mutations to points
will have no effect on this polygon.
Parameters | |
---|---|
points |
List :
a list of LatLng s that are the vertices of the polygon.
|
Sets the stroke color of this polygon.
Parameters | |
---|---|
color |
int :
the color in ARGB format
|
Sets the stroke pattern of the polygon's outline. The default stroke pattern is solid,
represented by null
.
Parameters | |
---|---|
pattern |
List :
the stroke pattern.
|
Sets the stroke width of this polygon.
Parameters | |
---|---|
width |
float :
the width in display pixels.
|
Sets the tag for the polygon.
You can use this property to associate an arbitrary Object
with this polygon. For
example, the Object
can contain data about what the polygon represents. This is
easier than storing a separate Map<Polygon, Object>
. As another example, you can
associate a String
ID corresponding to the ID from a data set. Google Maps Android
API neither reads nor writes this property. It is your responsibility to call
setTag(null)
to clear the tag when you no longer need it, to prevent memory leaks in
your app.
Parameters | |
---|---|
tag |
Object :
if null, the tag is cleared.
|
Sets the visibility of this polygon. When not visible, a polygon is not drawn, but it keeps all its other properties.
Parameters | |
---|---|
visible |
boolean :
if true , then the polygon is visible; if false , it is not.
|
Sets the zIndex of this polygon. Polygons with higher zIndices are drawn above those with lower indices.
Parameters | |
---|---|
zIndex |
float :
the zIndex of this polygon.
|