com.tomtom.online.sdk.map

Class PolylineBuilder

java.lang.Object

com.tomtom.online.sdk.map.PolylineBuilder

public class PolylineBuilder
extends java.lang.Object

Polyline overlay for the map.

Method Summary

Modifier and Type	Method and Description
Polyline	build() Create polyline overlay for a given map view.
PolylineBuilder	color(int color) The color in RGBA format of the overlay
PolylineBuilder	coordinates(java.util.List<LatLng> coordinates) Set list of polyline corners.
static PolylineBuilder	create()
PolylineBuilder	id(long id) The id of the Overlay.
PolylineBuilder	opacity(float opacity) Overlay opacity.
PolylineBuilder	tag(java.io.Serializable tag) It can be used for filtering, e.g.
PolylineBuilder	width(float width) Sets polyline width in pixels.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

coordinates

public PolylineBuilder coordinates(java.util.List<LatLng> coordinates)

Set list of polyline corners.

Parameters:

coordinates - List of polyline corners.

width

public PolylineBuilder width(float width)

Sets polyline width in pixels. Should be greater than 0. Default value is

Parameters:

width - Polyline width.

id

public PolylineBuilder id(long id)

The id of the Overlay. It is unique value which distinguish overlays.

tag

public PolylineBuilder tag(java.io.Serializable tag)

It can be used for filtering, e.g. to remove annotation of certain tag. Default value is set to null.@param tag the overlay tag. Default value is null.

color

public PolylineBuilder color(int color)

The color in RGBA format of the overlay

Parameters:

color - overlay color. Default value is WHITE.

opacity

public PolylineBuilder opacity(float opacity)

Overlay opacity. Must be between 0.0 and 1.0.

Parameters:

opacity - Overlay opacity.

create

public static PolylineBuilder create()

build

public Polyline build()

Create polyline overlay for a given map view. Polyline width must be greater than 0. Minimum number of points must be 2. Otherwise, the exception is thrown.

Returns:

the newly created Polyline object.