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	getApiBaseUri()
java.lang.String	getApiBaseUrl() Deprecated. use getApiBaseUri() instead
Style.Builder	getBuilder()
CameraPosition	getCameraPosition()
int	getHeight()
java.lang.String	getLocalIdeographFontFamily()
float	getPixelRatio()
LatLngBounds	getRegion()
java.lang.String	getStyleJson()
java.lang.String	getStyleUri()
java.lang.String	getStyleUrl() Deprecated. use getStyleUri() instead
int	getWidth()
MapSnapshotter.Options	withApiBaseUri(java.lang.String apiBaseUri) Specifies the URI used for API endpoint.
MapSnapshotter.Options	withApiBaseUrl(java.lang.String apiBaseUrl) Deprecated. use withApiBaseUri(String) instead
MapSnapshotter.Options	withCameraPosition(CameraPosition cameraPosition)
MapSnapshotter.Options	withGlyphsRasterizationMode(GlyphsRasterizationMode glyphsRasterizationMode) Experimental.
MapSnapshotter.Options	withLocalIdeographFontFamily(java.lang.String... fontFamilies) Set a font family from range of font families for generating glyphs locally for ideographs in the 'CJK Unified Ideographs' and 'Hangul Syllables' ranges.
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 uri) Deprecated. use withStyleBuilder(Style.Builder) instead
MapSnapshotter.Options	withStyleBuilder(Style.Builder builder) Set a style builder to snapshotter, the contents in builder like layers/sources/images will be applied to snapshotter.
MapSnapshotter.Options	withStyleJson(java.lang.String styleJson) Deprecated. use withStyleBuilder(Style.Builder) instead

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

withStyleBuilder

@NonNull
public MapSnapshotter.Options withStyleBuilder(Style.Builder builder)

Set a style builder to snapshotter, the contents in builder like layers/sources/images will be applied to snapshotter.

Parameters:

builder - The builder will applied to snapshotter

Returns:

the mutated MapSnapshotter.Options

getBuilder

public Style.Builder getBuilder()

withStyle

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

Deprecated. use withStyleBuilder(Style.Builder) instead

Parameters:

uri - The style URI to use

Returns:

the mutated MapSnapshotter.Options

withStyleJson

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

Deprecated. use withStyleBuilder(Style.Builder) instead

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' Default font for local ideograph font family is MapboxConstants.DEFAULT_FONT.

Parameters:

fontFamily - font family for local ideograph generation.

Returns:

the mutated MapSnapshotter.Options

withGlyphsRasterizationMode

@NonNull
public MapSnapshotter.Options withGlyphsRasterizationMode(GlyphsRasterizationMode glyphsRasterizationMode)

Experimental. Set the glyphs rasterization mode for generating glyphs locally for ideographs in the ' CJK Unified Ideographs' and 'Hangul Syllables' ranges.

The glyphs rasterization mode argument is passed to Typeface.create(String, int). Default glyphs rasterization mode is GlyphsRasterizationMode.NO_GLYPHS_RASTERIZED_LOCALLY.

Parameters:

glyphsRasterizationMode - glyphs rasterization mode for local ideograph generation.

Returns:

the mutated MapSnapshotter.Options

withLocalIdeographFontFamily

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

Set a font family from range of font families for generating glyphs locally for ideographs in the 'CJK Unified Ideographs' and 'Hangul Syllables' ranges.

The font families are checked against the default system fonts defined in '/system/etc/fonts.xml'. Default font for local ideograph font family is MapboxConstants.DEFAULT_FONT.

Parameters:

fontFamilies - font families for local ideograph generation.

Returns:

the mutated MapSnapshotter.Options

withApiBaseUrl

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

Deprecated. use withApiBaseUri(String) instead

Specifies the URL used for API endpoint.

Parameters:

apiBaseUrl - The base of our API endpoint

Returns:

the mutated MapSnapshotter.Options

withApiBaseUri

@NonNull
public MapSnapshotter.Options withApiBaseUri(java.lang.String apiBaseUri)

Specifies the URI used for API endpoint.

Parameters:

apiBaseUri - 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

@Deprecated
public java.lang.String getStyleUrl()

Deprecated. use getStyleUri() instead

Returns:

the style url

getStyleUri

public java.lang.String getStyleUri()

Returns:

the style uri

getStyleJson

@Nullable
public java.lang.String getStyleJson()

Returns:

the style json

getCameraPosition

@Nullable
public CameraPosition getCameraPosition()

Returns:

the camera position

getLocalIdeographFontFamily

public java.lang.String getLocalIdeographFontFamily()

Returns:

the font family used for locally generating ideographs, Default font for local ideograph font family is MapboxConstants.DEFAULT_FONT.

getApiBaseUrl

@Nullable
 @Deprecated
public java.lang.String getApiBaseUrl()

Deprecated. use getApiBaseUri() instead

Returns:

The base of our API endpoint

getApiBaseUri

@Nullable
public java.lang.String getApiBaseUri()

Returns:

The base of our API endpoint