NbmapStaticMap.Builder (services API)

java.lang.Object
- com.nbmap.api.staticmap.v1.NbmapStaticMap.Builder

Enclosing class:

NbmapStaticMap
```
public abstract static class NbmapStaticMap.Builder
extends java.lang.Object
```
Static image builder used to customize the image, including location, image width/height, and camera position.

Since:

1.0.0

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract NbmapStaticMap.Builder`	`accessToken(java.lang.String accessToken)` Required to call when this is being built.
`abstract NbmapStaticMap.Builder`	`attribution(boolean attribution)` Optionally, control whether there is attribution on the image.
`abstract NbmapStaticMap.Builder`	`baseUrl(java.lang.String baseUrl)` Optionally change the APIs base URL to something other then the default Nbmap one.
`abstract NbmapStaticMap.Builder`	`beforeLayer(java.lang.String beforeLayer)` String value for controlling where the overlay is inserted in the style.
`NbmapStaticMap`	`build()` This uses the provided parameters set using the `NbmapStaticMap.Builder` and creates a new `NbmapStaticMap` object.
`abstract NbmapStaticMap.Builder`	`cameraAuto(boolean auto)` If auto is set to true, the viewport will fit the bounds of the overlay.
`abstract NbmapStaticMap.Builder`	`cameraBearing(double cameraBearing)` Optionally, bearing rotates the map around its center defined point given in `cameraPoint(Point)`.
`abstract NbmapStaticMap.Builder`	`cameraPitch(double cameraPitch)` Optionally, pitch tilts the map, producing a perspective effect.
`abstract NbmapStaticMap.Builder`	`cameraPoint(com.nbmap.geojson.Point cameraPoint)` Center point where the camera will be focused on.
`abstract NbmapStaticMap.Builder`	`cameraZoom(double cameraZoom)` Static maps camera zoom level.
`abstract NbmapStaticMap.Builder`	`geoJson(com.nbmap.geojson.GeoJson geoJson)` GeoJSON object which represents a specific annotation which will be placed on the static map.
`abstract NbmapStaticMap.Builder`	`height(int height)` Height of the image.
`abstract NbmapStaticMap.Builder`	`logo(boolean logo)` Optionally, control whether there is a Nbmap logo on the image.
`abstract NbmapStaticMap.Builder`	`precision(int precision)` In order to make the returned image better cache-able on the client, you can set the precision in decimals instead of manually round the parameters.
`abstract NbmapStaticMap.Builder`	`retina(boolean retina)` Enhance your image by toggling retina to true.
`abstract NbmapStaticMap.Builder`	`staticMarkerAnnotations(java.util.List<StaticMarkerAnnotation> staticMarkerAnnotations)` Optionally provide a list of marker annotations which can be placed on the static map image during the rendering process.
`abstract NbmapStaticMap.Builder`	`staticPolylineAnnotations(java.util.List<StaticPolylineAnnotation> staticPolylineAnnotations)` Optionally provide a list of polyline annotations which can be placed on the static map image during the rendering process.
`abstract NbmapStaticMap.Builder`	`styleId(java.lang.String styleId)` The returning map images style, which can be one of the provided Nbmap Styles or a custom style made inside Nbmap Studio.
`abstract NbmapStaticMap.Builder`	`user(java.lang.String user)` The username for the account that the directions engine runs on.
`abstract NbmapStaticMap.Builder`	`width(int width)` Width of the image.

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
  - accessToken
```
public abstract NbmapStaticMap.Builder accessToken(@NonNull
                                                   java.lang.String accessToken)
```
    Required to call when this is being built. If no access token provided, ServicesException will be thrown.
    
    Parameters:
    
    accessToken - Nbmap access token, You must have a Nbmap account inorder to use the Optimization API
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - baseUrl
```
public abstract NbmapStaticMap.Builder baseUrl(@NonNull
                                               java.lang.String baseUrl)
```
    Optionally change the APIs base URL to something other then the default Nbmap one.
    
    Parameters:
    
    baseUrl - base url used as end point
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - user
```
public abstract NbmapStaticMap.Builder user(@NonNull
                                            java.lang.String user)
```
    The username for the account that the directions engine runs on. In most cases, this should always remain the default value of Constants.NBMAP_USER.
    
    Parameters:
    
    user - a non-null string which will replace the default user used in the directions request
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - styleId
```
public abstract NbmapStaticMap.Builder styleId(@NonNull
                                               java.lang.String styleId)
```
    The returning map images style, which can be one of the provided Nbmap Styles or a custom style made inside Nbmap Studio. Passing null will revert to using the default map Street style.
    
    Parameters:
    
    styleId - either one of the styles defined inside StaticMapCriteria or a custom url pointing to a styled map made in Nbmap Studio
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - logo
```
public abstract NbmapStaticMap.Builder logo(boolean logo)
```
    Optionally, control whether there is a Nbmap logo on the image. Default is true. Check that the current Nbmap plan you are under allows for hiding the Nbmap Logo from the mao.
    
    Parameters:
    
    logo - true places Nbmap logo on image
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - attribution
```
public abstract NbmapStaticMap.Builder attribution(boolean attribution)
```
    Optionally, control whether there is attribution on the image. Default is true. Check that the current Nbmap plan you are under allows for hiding the Nbmap Logo from the mao.
    
    Parameters:
    
    attribution - true places attribution on image
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - retina
```
public abstract NbmapStaticMap.Builder retina(boolean retina)
```
    Enhance your image by toggling retina to true. This will double the amount of pixels the returning image will have.
    
    Parameters:
    
    retina - true if the desired image being returned should contain double pixels
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - cameraPoint
```
public abstract NbmapStaticMap.Builder cameraPoint(@Nullable
                                                   com.nbmap.geojson.Point cameraPoint)
```
    Center point where the camera will be focused on.
    
    Parameters:
    
    cameraPoint - a GeoJSON Point object which defines the cameras center position
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - cameraZoom
```
public abstract NbmapStaticMap.Builder cameraZoom(double cameraZoom)
```
    Static maps camera zoom level. This can be though of as how far away the camera is from the subject (earth) thus a zoom of 0 will display the entire world vs zoom 16 which is street\ level zoom level. Fractional zoom levels will be rounded to two decimal places.
    
    Parameters:
    
    cameraZoom - double number between 0 and 22
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - cameraBearing
```
public abstract NbmapStaticMap.Builder cameraBearing(double cameraBearing)
```
    Optionally, bearing rotates the map around its center defined point given in cameraPoint(Point). A value of 90 rotates the map 90 to the left. 180 flips the map. Defaults is 0.
    
    Parameters:
    
    cameraBearing - double number between 0 and 360, interpreted as decimal degrees
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - cameraPitch
```
public abstract NbmapStaticMap.Builder cameraPitch(double cameraPitch)
```
    Optionally, pitch tilts the map, producing a perspective effect. Defaults is 0.
    
    Parameters:
    
    cameraPitch - double number between 0 and 60
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - cameraAuto
```
public abstract NbmapStaticMap.Builder cameraAuto(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:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - beforeLayer
```
public abstract NbmapStaticMap.Builder beforeLayer(@Nullable
                                                   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 - s string representing the map layer you'd like to place your overlays below.
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - width
```
public abstract NbmapStaticMap.Builder width(int width)
```
    Width of the image.
    
    Parameters:
    
    width - int number between 1 and 1280.
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - height
```
public abstract NbmapStaticMap.Builder height(int height)
```
    Height of the image.
    
    Parameters:
    
    height - int number between 1 and 1280.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - geoJson
```
public abstract NbmapStaticMap.Builder geoJson(@Nullable
                                               com.nbmap.geojson.GeoJson geoJson)
```
    GeoJSON object which represents a specific annotation which will be placed on the static map. The GeoJSON must be value.
    
    Parameters:
    
    geoJson - a formatted string ready to be added to the static map image URL
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - staticMarkerAnnotations
```
public abstract NbmapStaticMap.Builder staticMarkerAnnotations(@Nullable
                                                               java.util.List<StaticMarkerAnnotation> staticMarkerAnnotations)
```
    Optionally provide a list of marker annotations which can be placed on the static map image during the rendering process.
    
    Parameters:
    
    staticMarkerAnnotations - a list made up of StaticMarkerAnnotation objects
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - staticPolylineAnnotations
```
public abstract NbmapStaticMap.Builder staticPolylineAnnotations(@Nullable
                                                                 java.util.List<StaticPolylineAnnotation> staticPolylineAnnotations)
```
    Optionally provide a list of polyline annotations which can be placed on the static map image during the rendering process.
    
    Parameters:
    
    staticPolylineAnnotations - a list made up of StaticPolylineAnnotation objects
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - precision
```
public abstract NbmapStaticMap.Builder precision(int precision)
```
    In order to make the returned image better cache-able on the client, you can set the precision in decimals instead of manually round the parameters.
    
    Parameters:
    
    precision - integer value greater than zero which represents the decimal precision of coordinate values
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - build
```
public NbmapStaticMap build()
```
    This uses the provided parameters set using the NbmapStaticMap.Builder and creates a new NbmapStaticMap object.
    
    Returns:
    
    a new instance of NbmapStaticMap
    
    Since:
    
    2.1.0

Class NbmapStaticMap.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

accessToken

baseUrl

user

styleId

logo

attribution

retina

cameraPoint

cameraZoom

cameraBearing

cameraPitch

cameraAuto

beforeLayer

width

height

geoJson

staticMarkerAnnotations

staticPolylineAnnotations

precision

build