com.mapbox.api.staticmap.v1.models

Class StaticPolylineAnnotation.Builder

java.lang.Object

com.mapbox.api.staticmap.v1.models.StaticPolylineAnnotation.Builder

Enclosing class:

StaticPolylineAnnotation

public abstract static class StaticPolylineAnnotation.Builder
extends java.lang.Object

Builder used for passing in custom parameters.

Since:

2.1.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract StaticPolylineAnnotation	build() This uses the provided parameters set using the StaticPolylineAnnotation.Builder and creates a new StaticMarkerAnnotation object which can be passed into the MapboxStaticMap request.
StaticPolylineAnnotation.Builder	fillColor(int red, int green, int blue) Set the inner line fill color.
abstract StaticPolylineAnnotation.Builder	fillColor(java.lang.String color) Set the inner line fill color.
abstract StaticPolylineAnnotation.Builder	fillOpacity(java.lang.Float fillOpacity) Value between 0, completely transparent, and 1, opaque for the line fill.
abstract StaticPolylineAnnotation.Builder	polyline(java.lang.String polyline) The current polyline string being used for the paths geometry.
StaticPolylineAnnotation.Builder	strokeColor(int red, int green, int blue) Set the line outer stroke color.
abstract StaticPolylineAnnotation.Builder	strokeColor(java.lang.String strokeColor) Set the line outer stroke color.
abstract StaticPolylineAnnotation.Builder	strokeOpacity(java.lang.Float strokeOpacity) Value between 0, completely transparent, and 1, opaque for the line stroke.
abstract StaticPolylineAnnotation.Builder	strokeWidth(java.lang.Double strokeWidth) Defines the line stroke width for the path.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

strokeWidth

public abstract StaticPolylineAnnotation.Builder strokeWidth(@Nullable
                                                             java.lang.Double strokeWidth)

Defines the line stroke width for the path.

Parameters:

strokeWidth - a double value defining the stroke width

Returns:

this builder for chaining options together

Since:

2.1.0

strokeColor

public abstract StaticPolylineAnnotation.Builder strokeColor(@Nullable
                                                             java.lang.String strokeColor)

Set the line outer stroke color.

Parameters:

strokeColor - string representing hex color for the stroke color

Returns:

this builder for chaining options together

Since:

2.1.0

strokeColor

public StaticPolylineAnnotation.Builder strokeColor(int red,
                                                    int green,
                                                    int blue)

Set the line outer stroke color.

Parameters:

red - the value of the stroke color

green - the value of the stroke color

blue - the value of the stroke color

Returns:

this builder for chaining options together

Since:

3.1.0

strokeOpacity

public abstract StaticPolylineAnnotation.Builder strokeOpacity(@Nullable
                                                               java.lang.Float strokeOpacity)

Value between 0, completely transparent, and 1, opaque for the line stroke.

Parameters:

strokeOpacity - value between 0 and 1 representing the stroke opacity

Returns:

this builder for chaining options together

Since:

2.1.0

fillColor

public abstract StaticPolylineAnnotation.Builder fillColor(@Nullable
                                                           java.lang.String color)

Set the inner line fill color.

Parameters:

color - string representing hex color for the fill color

Returns:

this builder for chaining options together

Since:

2.1.0

fillColor

public StaticPolylineAnnotation.Builder fillColor(int red,
                                                  int green,
                                                  int blue)

Set the inner line fill color.

Parameters:

red - the value of the fill color

green - the value of the fill color

blue - the value of the fill color

Returns:

this builder for chaining options together

Since:

3.1.0

fillOpacity

public abstract StaticPolylineAnnotation.Builder fillOpacity(@Nullable
                                                             java.lang.Float fillOpacity)

Value between 0, completely transparent, and 1, opaque for the line fill.

Parameters:

fillOpacity - value between 0 and 1 representing the fill opacity

Returns:

this builder for chaining options together

Since:

2.1.0

polyline

public abstract StaticPolylineAnnotation.Builder polyline(@NonNull
                                                          java.lang.String polyline)

The current polyline string being used for the paths geometry. You can use PolylineUtils.decode(String, int) to decode the string using precision 5.

Parameters:

polyline - a String containing the paths geometry information

Returns:

this builder for chaining options together

Since:

2.1.0

build

public abstract StaticPolylineAnnotation build()

This uses the provided parameters set using the StaticPolylineAnnotation.Builder and creates a new StaticMarkerAnnotation object which can be passed into the MapboxStaticMap request.

Returns:

a new instance of StaticPolylineAnnotation

Since:

2.1.0