com.mapbox.mapboxsdk.snapshotter

Class MapSnapshotter.Options

java.lang.Object

com.mapbox.mapboxsdk.snapshotter.MapSnapshotter.Options

Enclosing class:

MapSnapshotter

public static class MapSnapshotter.Options
extends java.lang.Object

MapSnapshotter options

Constructor Summary

Constructors

Constructor and Description
Options(int width, int height)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiBaseUrl()
CameraPosition	getCameraPosition()
int	getHeight()
java.lang.String	getLocalIdeographFontFamily()
float	getPixelRatio()
LatLngBounds	getRegion()
java.lang.String	getStyleUrl()
int	getWidth()
MapSnapshotter.Options	withApiBaseUrl(java.lang.String apiBaseUrl) Specifies the URL used for API endpoint.
MapSnapshotter.Options	withCameraPosition(CameraPosition cameraPosition)
MapSnapshotter.Options	withLocalIdeographFontFamily(java.lang.String fontFamily) Set the font family for generating glyphs locally for ideographs in the 'CJK Unified Ideographs' and 'Hangul Syllables' ranges.
MapSnapshotter.Options	withLogo(boolean showLogo)
MapSnapshotter.Options	withPixelRatio(float pixelRatio)
MapSnapshotter.Options	withRegion(LatLngBounds region)
MapSnapshotter.Options	withStyle(java.lang.String url)
MapSnapshotter.Options	withStyleJson(java.lang.String styleJson)

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options(int width,
               int height)

Parameters:

width - the width of the image

height - the height of the image

Method Detail

withStyle

@NonNull
public MapSnapshotter.Options withStyle(java.lang.String url)

Parameters:

url - The style URL to use

Returns:

the mutated MapSnapshotter.Options

withStyleJson

@NonNull
public MapSnapshotter.Options withStyleJson(java.lang.String styleJson)

Parameters:

styleJson - The style json to use

Returns:

the mutated MapSnapshotter.Options

withRegion

@NonNull
public MapSnapshotter.Options withRegion(LatLngBounds region)

Parameters:

region - the region to show in the snapshot. This is applied after the camera position

Returns:

the mutated MapSnapshotter.Options

withPixelRatio

@NonNull
public MapSnapshotter.Options withPixelRatio(float pixelRatio)

Parameters:

pixelRatio - the pixel ratio to use (default: 1)

Returns:

the mutated MapSnapshotter.Options

withCameraPosition

@NonNull
public MapSnapshotter.Options withCameraPosition(CameraPosition cameraPosition)

Parameters:

cameraPosition - The camera position to use, the CameraPosition.target is overridden by region if set in conjunction.

Returns:

the mutated MapSnapshotter.Options

withLogo

@NonNull
public MapSnapshotter.Options withLogo(boolean showLogo)

Parameters:

showLogo - The flag indicating to show the Mapbox logo.

Returns:

the mutated MapSnapshotter.Options

withLocalIdeographFontFamily

@NonNull
public MapSnapshotter.Options withLocalIdeographFontFamily(java.lang.String fontFamily)

Set the font family for generating glyphs locally for ideographs in the 'CJK Unified Ideographs' and 'Hangul Syllables' ranges.

The font family argument is passed to Typeface.create(String, int). Default system fonts are defined in '/system/etc/fonts.xml'

Parameters:

fontFamily - font family for local ideograph generation.

Returns:

the mutated MapSnapshotter.Options

withApiBaseUrl

@NonNull
public MapSnapshotter.Options withApiBaseUrl(java.lang.String apiBaseUrl)

Specifies the URL used for API endpoint.

Parameters:

apiBaseUrl - The base of our API endpoint

Returns:

the mutated MapSnapshotter.Options

getWidth

public int getWidth()

Returns:

the width of the image

getHeight

public int getHeight()

Returns:

the height of the image

getPixelRatio

public float getPixelRatio()

Returns:

the pixel ratio

getRegion

@Nullable
public LatLngBounds getRegion()

Returns:

the region

getStyleUrl

public java.lang.String getStyleUrl()

Returns:

the style url

getCameraPosition

@Nullable
public CameraPosition getCameraPosition()

Returns:

the camera position

getLocalIdeographFontFamily

public java.lang.String getLocalIdeographFontFamily()

Returns:

the font family used for locally generating ideographs

getApiBaseUrl

@Nullable
public java.lang.String getApiBaseUrl()

Returns:

The base of our API endpoint