com.mapbox.api.staticmap.v1

Class MapboxStaticMap

java.lang.Object

com.mapbox.api.staticmap.v1.MapboxStaticMap

public abstract class MapboxStaticMap
extends java.lang.Object

Static maps are standalone images that can be displayed in your mobile app without the aid of a mapping library like the Mapbox Android SDK. They look like an embedded map without interactivity or controls. the returned image can be a raster tile ans pulls from any map style in the Mapbox Style Specification.

This class helps make a valid request and gets the information correctly formatted for Picaso or Glide libraries which help download the image and place it into an Image View.

Since:

1.0.0

See Also:

API Documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapboxStaticMap.Builder Static image builder used to customize the image, including location, image width/height, and camera position.

Constructor Summary

Constructors

Constructor and Description
MapboxStaticMap()

Method Summary

Modifier and Type	Method and Description
static MapboxStaticMap.Builder	builder() Build a new MapboxStaticMap object with the initial values set for baseUrl(), user(), attribution(), styleId(), and retina().
okhttp3.HttpUrl	url() Returns the formatted URL string meant to be passed to your Http client for retrieval of the actual Mapbox Static Image.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapboxStaticMap

public MapboxStaticMap()

Method Detail

url

public okhttp3.HttpUrl url()

Returns the formatted URL string meant to be passed to your Http client for retrieval of the actual Mapbox Static Image.

Returns:

a HttpUrl which can be used for making the request for the image

Since:

3.0.0

builder

public static MapboxStaticMap.Builder builder()

Build a new MapboxStaticMap object with the initial values set for baseUrl(), user(), attribution(), styleId(), and retina().

Returns:

a MapboxStaticMap.Builder object for creating this object

Since:

3.0.0