com.mapbox.api.staticmap.v1.models

Class StaticMarkerAnnotation.Builder

java.lang.Object

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

Enclosing class:

StaticMarkerAnnotation

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

This builder is used to create a new request to the Mapbox Static Map API. At a bare minimum, your request must include a name and lnglat(Point). All other fields can be left alone inorder to use the default behaviour of the API.

Since:

2.1.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
StaticMarkerAnnotation	build() Build a new marker instance and pass it into MapboxStaticMap in order to use it during your Static Map API request.
StaticMarkerAnnotation.Builder	color(int red, int green, int blue) A hex representation of the markers color.
abstract StaticMarkerAnnotation.Builder	color(java.lang.String color) A hex representation of the markers color.
abstract StaticMarkerAnnotation.Builder	iconUrl(java.lang.String url) a percent-encoded URL for the marker image.
abstract StaticMarkerAnnotation.Builder	label(java.lang.String label) Marker symbol.
abstract StaticMarkerAnnotation.Builder	lnglat(com.mapbox.geojson.Point lnglat) Represents where the marker should be shown on the map.
abstract StaticMarkerAnnotation.Builder	name(java.lang.String name) Modify the markers scale factor using one of the pre defined StaticMapCriteria.SMALL_PIN, StaticMapCriteria.MEDIUM_PIN, or StaticMapCriteria.LARGE_PIN.

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

name

public abstract StaticMarkerAnnotation.Builder name(java.lang.String name)

Modify the markers scale factor using one of the pre defined StaticMapCriteria.SMALL_PIN, StaticMapCriteria.MEDIUM_PIN, or StaticMapCriteria.LARGE_PIN.

Parameters:

name - one of the three string sizes provided in this methods summary

Returns:

this builder for chaining options together

Since:

2.1.0

label

public abstract StaticMarkerAnnotation.Builder label(java.lang.String label)

Marker symbol. Options are an alphanumeric label "a" through "z", "0" through "99", or a valid Maki icon. If a letter is requested, it will be rendered uppercase only.

Parameters:

label - a valid alphanumeric value

Returns:

this builder for chaining options together

Since:

2.1.0

color

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

A hex representation of the markers color.

Parameters:

color - hex reppresentation of the marker icon color

Returns:

this builder for chaining options together

Since:

3.1.0

color

public StaticMarkerAnnotation.Builder color(int red,
                                            int green,
                                            int blue)

A hex representation of the markers color.

Parameters:

red - the value of the marker icon color

green - the value of the marker icon color

blue - the value of the marker icon color

Returns:

this builder for chaining options together

Since:

3.1.0

lnglat

public abstract StaticMarkerAnnotation.Builder lnglat(com.mapbox.geojson.Point lnglat)

Represents where the marker should be shown on the map.

Parameters:

lnglat - a GeoJSON Point which denotes where the marker will be placed on the static map image. Altitude value, if given, will be ignored

Returns:

this builder for chaining options together

Since:

2.1.0

iconUrl

public abstract StaticMarkerAnnotation.Builder iconUrl(@Nullable
                                                       java.lang.String url)

a percent-encoded URL for the marker image. Can be of type PNG or JPG.

Parameters:

url - an encoded URL for the marker image

Returns:

this builder for chaining options together

Since:

2.1.0

build

public StaticMarkerAnnotation build()

Build a new marker instance and pass it into MapboxStaticMap in order to use it during your Static Map API request.

Returns:

a new instance of StaticMarkerAnnotation

Since:

2.1.0