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

Class StaticMarkerAnnotation

java.lang.Object

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

public class StaticMarkerAnnotation
extends java.lang.Object

Mapbox Static Image API marker overlay. Building this object allows you to place a marker on top or within your static image. The marker can either use the default marker (though you can change it's color and size) or you have the option to also pass in a custom marker icon using it's url.

Since:

2.1.0

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMarker() Gives a formatted string containing the built marker 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

StaticMarkerAnnotation

public StaticMarkerAnnotation(StaticMarkerAnnotation.Builder builder)

A StaticMarkerAnnotation constructor

Parameters:

builder - a StaticMarkerAnnotation builder.

Since:

2.1.0

Method Detail

getMarker

public java.lang.String getMarker()

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

Returns:

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

Since:

2.1.0