MapboxStaticImage.Builder (libjava-services 2.2.2 API)

java.lang.Object
- com.mapbox.services.api.MapboxBuilder
- - com.mapbox.services.api.staticimage.v1.MapboxStaticImage.Builder

Enclosing class:

MapboxStaticImage
```
public static class MapboxStaticImage.Builder
extends MapboxBuilder
```
Static image builder used to customize the image, including location, image width/height, and camera position.

Since:

1.0.0

Field Summary
- Fields inherited from class com.mapbox.services.api.MapboxBuilder
  baseUrl, clientAppName

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`MapboxStaticImage`	`build()` Build the client when all user parameters have been set.
`java.lang.String`	`getAccessToken()` Get the access token
`java.lang.String`	`getBeforeLayer()` Provides the string being used to represent the layer you wish to place all your overlays below.
`java.lang.String`	`getGeoJson()` If a `GeoJSON` object was provided, you can get the formatted version of it by calling this method.
`java.lang.String`	`getLocationPathSegment()` Gives location information about the static image including longitude, latitude, zoom, bearing, and pitch.
`java.lang.String`	`getOverlays()` Provides a String containing all of the currently added overlays added to the static image builder.
`int`	`getPrecision()`
`java.lang.String`	`getSizePathSegment()` Gives the height and width of the static image.
`java.lang.String`	`getStyleId()` Get what map style your static image will display.
`java.lang.String`	`getUsername()` Get the username you set within the builder.
`boolean`	`isAttribution()` Determine if the static image will contain attribution.
`boolean`	`isAuto()` Determine if auto has been set for the static image camera positioning.
`boolean`	`isLogo()` Determine if the static image will contain Mapbox logo.
`MapboxStaticImage.Builder`	`setAccessToken(java.lang.String accessToken)` Required to call when building `MapboxStaticImage.Builder`.
`MapboxStaticImage.Builder`	`setAttribution(boolean attribution)` Optionally, control whether there is attribution on the image.
`MapboxStaticImage.Builder`	`setAuto(boolean auto)` If auto is set to true, the viewport will fit the bounds of the overlay.
`MapboxBuilder`	`setBaseUrl(java.lang.String baseUrl)` Set the base url of the API.
`MapboxStaticImage.Builder`	`setBearing(double bearing)` Optionally, bearing rotates the map around its center.
`MapboxStaticImage.Builder`	`setBeforeLayer(java.lang.String beforeLayer)` String value for controlling where the overlay is inserted in the style.
`MapboxStaticImage.Builder`	`setClientAppName(java.lang.String appName)` Set the App Name to identify
`MapboxStaticImage.Builder`	`setGeoJson(com.mapbox.services.commons.geojson.GeoJSON geoJson)` Pass in a `GeoJSON` object which contains geometry where you'd like your annotations to be placed.
`MapboxStaticImage.Builder`	`setHeight(int height)` Height of the image.
`MapboxStaticImage.Builder`	`setLat(double lat)` Latitude for the center point of the static map.
`MapboxStaticImage.Builder`	`setLocation(com.mapbox.services.commons.models.Position position)` Deprecated. Use `setPosition(Position)` instead.
`MapboxStaticImage.Builder`	`setLogo(boolean logo)` Optionally, control whether there is a Mapbox logo on the image.
`MapboxStaticImage.Builder`	`setLon(double lon)` Longitude for the center point of the static map.
`MapboxStaticImage.Builder`	`setPitch(double pitch)` Optionally, pitch tilts the map, producing a perspective effect.
`MapboxStaticImage.Builder`	`setPosition(com.mapbox.services.commons.models.Position position)` Location for the center point of the static map.
`MapboxStaticImage.Builder`	`setPrecision(int precision)` In order to make the returned images better cacheable on the client, you can set the precision in decimals instead of manually rounding the parameters.
`MapboxStaticImage.Builder`	`setRetina(boolean retina)` Optionally, use to request a retina 2x image that will be returned.
`MapboxStaticImage.Builder`	`setStaticMarkerAnnotations(StaticMarkerAnnotation... staticMarkerAnnotations)` Allows the passing of a `StaticMarkerAnnotation` or Markers which are placed on the static map image returned.
`MapboxStaticImage.Builder`	`setStaticPolylineAnnotations(StaticPolylineAnnotation... staticPolylineAnnotations)` Allows the passing of a `StaticPolylineAnnotation` or Polylines which are placed on the static map image returned.
`MapboxStaticImage.Builder`	`setStyleId(java.lang.String styleId)` You'll need to set what map style you'd like the static image to display.
`MapboxStaticImage.Builder`	`setUsername(java.lang.String username)` Set the map style username.
`MapboxStaticImage.Builder`	`setWidth(int width)` Width of the image.
`MapboxStaticImage.Builder`	`setZoom(double zoom)` static map zoom level.

Methods inherited from class com.mapbox.services.api.MapboxBuilder
getBaseUrl, getClientAppName, validateAccessToken

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
  - getGeoJson
```
public java.lang.String getGeoJson()
```
    If a GeoJSON object was provided, you can get the formatted version of it by calling this method.
    
    Returns:
    
    a formatted string ready to be added to the static image URL.
    
    Since:
    
    2.1.0
  - setGeoJson
```
public MapboxStaticImage.Builder setGeoJson(com.mapbox.services.commons.geojson.GeoJSON geoJson)
```
    Pass in a GeoJSON object which contains geometry where you'd like your annotations to be placed.
    
    Parameters:
    
    geoJson - a single GeoJSON object which includes at least one annotation.
    
    Returns:
    
    This Static image builder.
    
    Since:
    
    2.1.0
  - setAccessToken
```
public MapboxStaticImage.Builder setAccessToken(java.lang.String accessToken)
```
    Required to call when building MapboxStaticImage.Builder.
    
    Specified by:
    
    setAccessToken in class MapboxBuilder
    
    Parameters:
    
    accessToken - Mapbox access token, you must have a Mapbox account in order to use this library.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setUsername
```
public MapboxStaticImage.Builder setUsername(java.lang.String username)
```
    Set the map style username. Typically will either be your Mapbox username or if you are using one of the defaults Mapbox styles, the username will be "mapbox".
    
    Parameters:
    
    username - You will need to pass in your Mapbox username.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setStyleId
```
public MapboxStaticImage.Builder setStyleId(java.lang.String styleId)
```
    You'll need to set what map style you'd like the static image to display.
    
    Parameters:
    
    styleId - can be one of the defaults or your own.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setLon
```
public MapboxStaticImage.Builder setLon(double lon)
```
    Longitude for the center point of the static map.
    
    Parameters:
    
    lon - double number between -180 and 180.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setLat
```
public MapboxStaticImage.Builder setLat(double lat)
```
    Latitude for the center point of the static map.
    
    Parameters:
    
    lat - double number between -90 and 90.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setLocation
```
@Deprecated
public MapboxStaticImage.Builder setLocation(com.mapbox.services.commons.models.Position position)
```
    Deprecated. Use setPosition(Position) instead.
    
    Location for the center point of the static map.
    
    Parameters:
    
    position - Position object with valid latitude and longitude values
    
    Returns:
    
    Builder
    
    Since:
    
    1.2.0
  - setPosition
```
public MapboxStaticImage.Builder setPosition(com.mapbox.services.commons.models.Position position)
```
    Location for the center point of the static map.
    
    Parameters:
    
    position - Position object with valid latitude and longitude values
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - setZoom
```
public MapboxStaticImage.Builder setZoom(double zoom)
```
    static map zoom level. Fractional zoom levels will be rounded to two decimal places.
    
    Parameters:
    
    zoom - double number between 0 and 22.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setBearing
```
public MapboxStaticImage.Builder setBearing(double bearing)
```
    Optionally, bearing rotates the map around its center. A value of 90 rotates the map 90 to the left. 180 flips the map. Defaults is 0.
    
    Parameters:
    
    bearing - double number between 0 and 360, interpreted as decimal degrees.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setPitch
```
public MapboxStaticImage.Builder setPitch(double pitch)
```
    Optionally, pitch tilts the map, producing a perspective effect. Defaults is 0.
    
    Parameters:
    
    pitch - double number between 0 and 60.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setAuto
```
public MapboxStaticImage.Builder setAuto(boolean auto)
```
    If auto is set to true, the viewport will fit the bounds of the overlay. Using this will replace any latitude or longitude you provide.
    
    Parameters:
    
    auto - true if you'd like the viewport to be centered to display all map annotations, defaults false.
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - isAuto
```
public boolean isAuto()
```
    Determine if auto has been set for the static image camera positioning.
    
    Returns:
    
    boolean true if auto has been set, otherwise false.
    
    Since:
    
    2.1.0
  - setWidth
```
public MapboxStaticImage.Builder setWidth(int width)
```
    Width of the image.
    
    Parameters:
    
    width - int number between 1 and 1280.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setHeight
```
public MapboxStaticImage.Builder setHeight(int height)
```
    Height of the image.
    
    Parameters:
    
    height - int number between 1 and 1280.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setRetina
```
public MapboxStaticImage.Builder setRetina(boolean retina)
```
    Optionally, use to request a retina 2x image that will be returned.
    
    Parameters:
    
    retina - true if you'd like a retina image.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setAttribution
```
public MapboxStaticImage.Builder setAttribution(boolean attribution)
```
    Optionally, control whether there is attribution on the image. Default is true.
    
    Parameters:
    
    attribution - true places attribution on image.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setLogo
```
public MapboxStaticImage.Builder setLogo(boolean logo)
```
    Optionally, control whether there is a Mapbox logo on the image. Default is true.
    
    Parameters:
    
    logo - true places Mapbox logo on image.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setPrecision
```
public MapboxStaticImage.Builder setPrecision(int precision)
```
    In order to make the returned images better cacheable on the client, you can set the precision in decimals instead of manually rounding the parameters.
    
    Parameters:
    
    precision - int number representing the precision for the formatter
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setBeforeLayer
```
public MapboxStaticImage.Builder setBeforeLayer(java.lang.String beforeLayer)
```
    String value for controlling where the overlay is inserted in the style. All overlays will be inserted before this specified layer.
    
    Parameters:
    
    beforeLayer - A string representing the map layer you'd like to place your overlays below.
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - getBeforeLayer
```
public java.lang.String getBeforeLayer()
```
    Provides the string being used to represent the layer you wish to place all your overlays below.
    
    Returns:
    
    a String representing the map styles layer.
    
    Since:
    
    2.1.0
  - getAccessToken
```
public java.lang.String getAccessToken()
```
    Get the access token
    
    Specified by:
    
    getAccessToken in class MapboxBuilder
    
    Returns:
    
    String with the access token
    
    Since:
    
    1.0.0
  - getUsername
```
public java.lang.String getUsername()
```
    Get the username you set within the builder. Typically your own Mapbox username or if you used a defaults Mapbox style, it will be "mapbox".
    
    Returns:
    
    String with the username.
    
    Since:
    
    1.0.0
  - getStyleId
```
public java.lang.String getStyleId()
```
    Get what map style your static image will display.
    
    Returns:
    
    String containing static map id.
    
    Since:
    
    1.0.0
  - getLocationPathSegment
```
public java.lang.String getLocationPathSegment()
```
    Gives location information about the static image including longitude, latitude, zoom, bearing, and pitch.
    
    Returns:
    
    String value with static image location information.
    
    Since:
    
    1.0.0
  - getSizePathSegment
```
public java.lang.String getSizePathSegment()
```
    Gives the height and width of the static image.
    
    Returns:
    
    String giving width, height and retina.
    
    Since:
    
    1.0.0
  - setStaticMarkerAnnotations
```
public MapboxStaticImage.Builder setStaticMarkerAnnotations(StaticMarkerAnnotation... staticMarkerAnnotations)
```
    Allows the passing of a StaticMarkerAnnotation or Markers which are placed on the static map image returned.
    
    Parameters:
    
    staticMarkerAnnotations - One or more StaticMarkerAnnotations to be placed on your static image.
    
    Returns:
    
    This static image builder.
    
    Since:
    
    2.1.0
  - setStaticPolylineAnnotations
```
public MapboxStaticImage.Builder setStaticPolylineAnnotations(StaticPolylineAnnotation... staticPolylineAnnotations)
```
    Allows the passing of a StaticPolylineAnnotation or Polylines which are placed on the static map image returned.
    
    Parameters:
    
    staticPolylineAnnotations - One or more StaticPolylineAnnotations to be placed on your static image.
    
    Returns:
    
    This static image builder.
    
    Since:
    
    2.1.0
  - getOverlays
```
public java.lang.String getOverlays()
```
    Provides a String containing all of the currently added overlays added to the static image builder.
    
    Returns:
    
    the formatted string which will be used to pass in any overlays to be placed on the static image.
    
    Since:
    
    2.1.0
  - isAttribution
```
public boolean isAttribution()
```
    Determine if the static image will contain attribution.
    
    Returns:
    
    true if attribution will be on static image.
    
    Since:
    
    1.0.0
  - isLogo
```
public boolean isLogo()
```
    Determine if the static image will contain Mapbox logo.
    
    Returns:
    
    true if Mapbox logo will be on static image.
    
    Since:
    
    1.0.0
  - getPrecision
```
public int getPrecision()
```
    Returns:
    
    int number representing the precision for the formatter
    
    Since:
    
    1.0.0
  - setClientAppName
```
public MapboxStaticImage.Builder setClientAppName(java.lang.String appName)
```
    Description copied from class: MapboxBuilder
    
    Set the App Name to identify
    
    Specified by:
    
    setClientAppName in class MapboxBuilder
    
    Parameters:
    
    appName - base package name or other simple string identifier
    
    Returns:
    
    the current MapboxBuilder instance
  - setBaseUrl
```
public MapboxBuilder setBaseUrl(java.lang.String baseUrl)
```
    Set the base url of the API.
    
    Specified by:
    
    setBaseUrl in class MapboxBuilder
    
    Parameters:
    
    baseUrl - base url used as end point
    
    Returns:
    
    the current MapboxBuilder instance
    
    Since:
    
    2.0.0
  - build
```
public MapboxStaticImage build()
                        throws ServicesException
```
    Build the client when all user parameters have been set.
    
    Specified by:
    
    build in class MapboxBuilder
    
    Returns:
    
    MapboxStaticImage
    
    Throws:
    
    ServicesException - Generic Exception for all things Mapbox.
    
    Since:
    
    1.0.0

Class MapboxStaticImage.Builder

Field Summary

Fields inherited from class com.mapbox.services.api.MapboxBuilder

Constructor Summary

Method Summary

Methods inherited from class com.mapbox.services.api.MapboxBuilder

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

getGeoJson

setGeoJson

setAccessToken

setUsername

setStyleId

setLon

setLat

setLocation

setPosition

setZoom

setBearing

setPitch

setAuto

isAuto

setWidth

setHeight

setRetina

setAttribution

setLogo

setPrecision

setBeforeLayer

getBeforeLayer

getAccessToken

getUsername

getStyleId

getLocationPathSegment

getSizePathSegment

setStaticMarkerAnnotations

setStaticPolylineAnnotations

getOverlays

isAttribution

isLogo

getPrecision

setClientAppName

setBaseUrl

build