PolygonOptions

Package: com.eegeo.mapapi.polygons

Defines creation parameters for a Polygon.

Constructors

PolygonOptions()

Default constructor for polygon creation parameters.

Methods

PolygonOptions add(LatLng points)

Adds vertices to the end of the polygon.

Returns: The PolygonOptions object on which the method was called, with the new points added.

Type argument Description
LatLng points The points to add.

PolygonOptions add(LatLng point)

Adds a vertex to the end of the polygon.

Returns: The PolygonOptions object on which the method was called, with the new point added.

Type argument Description
LatLng point The point to add.

PolygonOptions addHole(Iterable<LatLng> points)

Adds a hole to the polygon being built.

Returns: The PolygonOptions object on which the method was called, with the new hole added.

Type argument Description
Iterable<LatLng> points The points which form the hole.

PolygonOptions elevation(double elevation)

Sets the elevation for the polygon. If this method is not called, PolygonOptions will be initialised to create a Polygon with an elevation of 0.

Returns: The PolygonOptions object on which the method was called, with the new elevation set.

Type argument Description
double elevation The elevation, in meters.

PolygonOptions elevationMode(ElevationMode ElevationMode)

Sets the ElevationMode for the polygon. If this method is not called, PolygonOptions will be initialised to create a Polygon with ElevationMode.HeightAboveGround.

Returns: The PolygonOptions object on which the method was called, with the new elevation mode set.

Type argument Description
ElevationMode ElevationMode The ElevationMode used to interpret the elevation of the polygon.

PolygonOptions indoor(String indoorMapId, int indoorFloorId)

Sets the indoor map properties for the polygon. If this method is not called, PolygonOptions is initialised to create a polygon for display on an outdoor map.

Returns: The PolygonOptions object on which the method was called, with the new indoor map properties set.

Type argument Description
String indoorMapId The identifier of the indoor map on which the polygon should be displayed.
int indoorFloorId The identifier of the indoor map floor on which the polygon should be displayed. In the WRLD Indoor Map Format, this corresponds to the ‘z_order’ field of the Level object.

PolygonOptions fillColor(int fillColor)

Sets the fill color of the polygon as a 32-bit ARGB color. The default value is opaque black (0xff000000).

Returns: The PolygonOptions object on which the method was called, with the new color set.

Type argument Description
int fillColor The fill color to use.

double getElevation()

Returns the elevation set for this PolygonOptions object.

Returns: A height, in meters.

ElevationMode getElevationMode()

Returns the elevation mode set for this PolygonOptions object.

Returns: The ElevationMode, indicating how elevation is interpreted.

String getIndoorMapId()

Returns the indoor map identifier for this PolygonOptions object.

Returns: A string containing the indoor map identifier.

int getIndoorFloorId()

Returns the indoor map floor identifier for this PolygonOptions object.

Returns: The indoor map floor id.

List<LatLng> getPoints()

Returns the points for this PolygonOptions object.

Returns: A list of LatLng objects specifying the polygon’s vertices.

List<List> getHoles()

Returns the holes for this PolygonOptions object.

Returns: A list of lists of LatLng objects specifying the vertices for each of the Polygon’s holes.

int getFillColor()

Returns the fill color set for this PolygonOptions object.

Returns: The fill color as a 32-bit ARGB color.

v0.0.1118
Overview Introduction
Picking PickResult
Widgets (Optional) BlueSphere
Tag Service (Optional) TagService OnTagsLoadCompletedListener
RouteView Widget (Optional) RouteView RouteViewOptions