com.mapbox.services.api.staticimage.v1.models

Class StaticPolylineAnnotation

java.lang.Object

com.mapbox.services.api.staticimage.v1.models.StaticPolylineAnnotation

public class StaticPolylineAnnotation
extends java.lang.Object

Mapbox Static Image API polyline overlay. Building this object allows you to place a line or object on top or within your static image. The polyline must be encoded with a precision of 5 decimal places and can be created using the PolylineUtils.encode(List, int).

Since:

2.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StaticPolylineAnnotation.Builder Builder used for passing in custom parameters.

Constructor Summary

Constructors

Constructor and Description
StaticPolylineAnnotation(StaticPolylineAnnotation.Builder builder) A StaticPolylineAnnotation constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPath() Gives a formatted string containing the built polyline for usage with the static image API.

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticPolylineAnnotation

public StaticPolylineAnnotation(StaticPolylineAnnotation.Builder builder)

A StaticPolylineAnnotation constructor

Parameters:

builder - a StaticPolylineAnnotation builder.

Since:

2.1.0

Method Detail

getPath

public java.lang.String getPath()

Gives a formatted string containing the built polyline for usage with the static image API.

Returns:

A String representing a single polyline object usable when requesting a static image.

Since:

2.1.0