public final class

PolygonOptions

extends Object
implements SafeParcelable
java.lang.Object
   ↳ com.google.android.gms.maps.model.PolygonOptions

Class Overview

Defines options for a polygon.

Developer Guide

For more information, read the Shapes developer guide.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
From interface com.google.android.gms.common.internal.safeparcel.SafeParcelable
Fields
public static final PolygonOptionsCreator CREATOR
Public Constructors
PolygonOptions()
Creates polygon options.
Public Methods
PolygonOptions add(LatLng point)
Adds a vertex to the outline of the polygon being built.
PolygonOptions add(LatLng... points)
Adds vertices to the outline of the polygon being built.
PolygonOptions addAll(Iterable<LatLng> points)
Adds vertices to the outline of the polygon being built.
PolygonOptions addHole(Iterable<LatLng> points)
Adds a hole to the polygon being built.
int describeContents()
PolygonOptions fillColor(int color)
Specifies the polygon's fill color, as 32-bit ARGB.
PolygonOptions geodesic(boolean geodesic)
Specifies whether to draw each segment of this polygon as a geodesic.
int getFillColor()
Gets the fill color set for this Options object.
List<List<LatLng>> getHoles()
Gets the holes set for this Options object.
List<LatLng> getPoints()
Gets the outline set for this Options object.
int getStrokeColor()
Gets the stroke color set for this Options object.
float getStrokeWidth()
Gets the stroke width set for this Options object.
float getZIndex()
Gets the zIndex set for this Options object.
boolean isGeodesic()
Gets the geodesic setting for this Options object.
boolean isVisible()
Gets the visibility setting for this Options object.
PolygonOptions strokeColor(int color)
Specifies the polygon's stroke color, as 32-bit ARGB.
PolygonOptions strokeWidth(float width)
Specifies the polygon's stroke width, in display pixels.
PolygonOptions visible(boolean visible)
Specifies the visibility for the polygon.
void writeToParcel(Parcel out, int flags)
PolygonOptions zIndex(float zIndex)
Specifies the polygon's zIndex, i.e., the order in which it will be drawn.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final PolygonOptionsCreator CREATOR

Public Constructors

public PolygonOptions ()

Creates polygon options.

Public Methods

public PolygonOptions add (LatLng point)

Adds a vertex to the outline of the polygon being built.

Returns
  • this PolygonOptions object with the given point added to the outline.

public PolygonOptions add (LatLng... points)

Adds vertices to the outline of the polygon being built.

Returns
  • this PolygonOptions object with the given points added to the outline.

public PolygonOptions addAll (Iterable<LatLng> points)

Adds vertices to the outline of the polygon being built.

Returns
  • this PolygonOptions object with the given points added to the outline.

public PolygonOptions addHole (Iterable<LatLng> points)

Adds a hole to the polygon being built.

Returns

public int describeContents ()

public PolygonOptions fillColor (int color)

Specifies the polygon's fill color, as 32-bit ARGB. The default color is black ( 0xff000000).

Returns

public PolygonOptions geodesic (boolean geodesic)

Specifies whether to draw each segment of this polygon as a geodesic. The default setting is false

Returns

public int getFillColor ()

Gets the fill color set for this Options object.

Returns
  • the fill color of the polygon in screen pixels.

public List<List<LatLng>> getHoles ()

Gets the holes set for this Options object.

Returns
  • the list of Lists specifying the holes of the polygon.

public List<LatLng> getPoints ()

Gets the outline set for this Options object.

Returns
  • the list of LatLngs specifying the vertices of the outline of the polygon.

public int getStrokeColor ()

Gets the stroke color set for this Options object.

Returns
  • the stroke color of the polygon in screen pixels.

public float getStrokeWidth ()

Gets the stroke width set for this Options object.

Returns
  • the stroke width of the polygon in screen pixels.

public float getZIndex ()

Gets the zIndex set for this Options object.

Returns
  • the zIndex of the polygon.

public boolean isGeodesic ()

Gets the geodesic setting for this Options object.

Returns
  • true if the polygon segments should be geodesics; false if they should not be.

public boolean isVisible ()

Gets the visibility setting for this Options object.

Returns
  • true if the polygon is to be visible; false if it is not.

public PolygonOptions strokeColor (int color)

Specifies the polygon's stroke color, as 32-bit ARGB. The default color is black ( 0xff000000).

Returns

public PolygonOptions strokeWidth (float width)

Specifies the polygon's stroke width, in display pixels. The default width is 10.

Returns

public PolygonOptions visible (boolean visible)

Specifies the visibility for the polygon. The default visibility is true.

Returns

public void writeToParcel (Parcel out, int flags)

public PolygonOptions zIndex (float zIndex)

Specifies the polygon's zIndex, i.e., the order in which it will be drawn. See the documentation at the top of this class for more information about zIndex.

Returns