PolylineOptions
Package: com.eegeo.mapapi.polylines
Defines creation parameters for a Polyline.
Constructors
PolylineOptions()
Default constructor for polyline creation parameters.
Methods
PolylineOptions add(LatLng points)
Adds vertices to the end of the polyline.
Returns: The PolylineOptions object on which the method was called, with the new points added.
| Type | argument | Description |
|---|---|---|
| LatLng | points | The points to add. |
PolylineOptions add(LatLng point)
Adds a vertex to the end of the polyline.
Returns: The PolylineOptions object on which the method was called, with the new point added.
| Type | argument | Description |
|---|---|---|
| LatLng | point | The point to add. |
PolylineOptions add(LatLng point, double heightOffset)
Add a vertex fo the end of the polyline with a vertical offset.
Returns: The PolylineOptions object on which the method was called, with the new point added.
| Type | argument | Description |
|---|---|---|
| LatLng | point | The point to add. |
| double | heightOffset | A height offset in metres. This is relative to the elevation set for the whole Polyline. |
PolylineOptions elevation(double elevation)
Sets the elevation for the polyline. If this method is not called, PolylineOptions will be initialised to create a Polyline with an elevation of 0.
Returns: The PolylineOptions object on which the method was called, with the new elevation set.
| Type | argument | Description |
|---|---|---|
| double | elevation | The elevation, in meters. |
PolylineOptions elevationMode(ElevationMode ElevationMode)
Sets the ElevationMode for the polyline. If this method is not called, PolylineOptions will be initialised to create a Polyline with ElevationMode.HeightAboveGround.
Returns: The PolylineOptions 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 polyline. |
PolylineOptions indoor(String indoorMapId, int indoorFloorId)
Sets the indoor map properties for the polyline. If this method is not called, PolylineOptions is initialised to create a polyline for display on an outdoor map.
Returns: The PolylineOptions 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 polyline should be displayed |
| int | indoorFloorId | the identifier of the indoor map floor on which the polyline should be displayed. In the WRLD Indoor Map Format, this corresponds to the ‘z_order’ field of the Level object. |
PolylineOptions width(float width)
Sets the width of the polyline in screen pixels.
Returns: The PolylineOptions object on which the method was called, with the new width set.
| Type | argument | Description |
|---|---|---|
| float | width | The width in screen pixels. |
PolylineOptions color(int color)
Sets the color of the polyline as a 32-bit ARGB color. The default value is opaque black (0xff000000).
Returns: The PolylineOptions object on which the method was called, with the new color set.
| Type | argument | Description |
|---|---|---|
| int | color | The color to use. |
PolylineOptions miterLimit(float miterLimit)
Sets the miter limit of the polyline, the maximum allowed ratio between the length of a miter diagonal at a join, and the line width.
Returns: The PolylineOptions object on which the method was called, with the new miter limit set.
| Type | argument | Description |
|---|---|---|
| float | miterLimit | The miter limit. |
double getElevation()
Returns the elevation set for this PolylineOptions object.
Returns: A height, in meters.
ElevationMode getElevationMode()
Returns the elevation mode set for this PolylineOptions object.
Returns: The ElevationMode, indicating how elevation is interpreted.
String getIndoorMapId()
Returns the indoor map identifier for this PolylineOptions object.
Returns: A string containing the indoor map identifier.
int getIndoorFloorId()
Returns the indoor map floor identifier for this PolylineOptions object.
Returns: The indoor map floor id.
List<LatLng> getPoints()
Returns the points for this PolylineOptions object.
Returns: A list of LatLng objects specifying the polyline’s vertices.
List<Double> getPerPointElevations()
float getWidth()
Returns the line width set for this PolylineOptions object. The default value is 10.
Returns: The line width.
int getColor()
Returns the color set for this PolylineOptions object.
Returns: The line color as a 32-bit ARGB color.
float getMiterLimit()
Returns the line miter limit set for this PolylineOptions object. The default value is 10, which would result in a polyline created from these options clamping the length of a join diagonal for join angles less than approximately 11 degrees.
Returns: The miter limit ratio used for miter joins.