com.mapbox.mapboxsdk.maps

Class MapboxMapOptions

java.lang.Object

com.mapbox.mapboxsdk.maps.MapboxMapOptions

All Implemented Interfaces:

android.os.Parcelable

public class MapboxMapOptions
extends java.lang.Object
implements android.os.Parcelable

Defines configuration MapboxMapMapOptions for a MapboxMap. These options can be used when adding a map to your application programmatically (as opposed to via XML). If you are using a MapFragment, you can pass these options in using the static factory method newInstance(MapboxMapOptions). If you are using a MapView, you can pass these options in using the constructor MapView(Context, MapboxMapOptions). If you add a map using XML, then you can apply these options using custom XML tags.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<MapboxMapOptions>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
MapboxMapOptions() Deprecated. Use createFromAttributes(Context, AttributeSet) instead.

Method Summary

Modifier and Type	Method and Description
MapboxMapOptions	apiBaseUri(java.lang.String apiBaseUri) Specifies the URI used for API endpoint.
MapboxMapOptions	apiBaseUrl(java.lang.String apiBaseUrl) Deprecated. use apiBaseUri instead
MapboxMapOptions	attributionEnabled(boolean enabled) Specifies the visibility state of a attribution for a map view.
MapboxMapOptions	attributionGravity(int gravity) Specifies the gravity state of attribution for a map view.
MapboxMapOptions	attributionMargins(int[] margins) Specifies the margin state of attribution for a map view
MapboxMapOptions	attributionTintColor(int color) Specifies the tint color of the attribution for a map view
MapboxMapOptions	camera(CameraPosition cameraPosition) Specifies a the initial camera position for the map view.
MapboxMapOptions	compassEnabled(boolean enabled) Specifies the visibility state of a mapbox_compass_icon for a map view.
MapboxMapOptions	compassFadesWhenFacingNorth(boolean compassFadeWhenFacingNorth) Specifies if the mapbox_compass_icon fades to invisible when facing north.
MapboxMapOptions	compassGravity(int gravity) Specifies the gravity state of mapbox_compass_icon for a map view.
MapboxMapOptions	compassImage(android.graphics.drawable.Drawable compass) Deprecated. use compassImageResource instead
MapboxMapOptions	compassImageResource(int compassImageResource) Specifies the image of the CompassView.
MapboxMapOptions	compassMargins(int[] margins) Specifies the margin state of mapbox_compass_icon for a map view
static MapboxMapOptions	createFromAttributes(android.content.Context context) Creates a default MapboxMapsOptions from a given context.
static MapboxMapOptions	createFromAttributes(android.content.Context context, android.util.AttributeSet attrs) Creates a MapboxMapsOptions from the attribute set.
MapboxMapOptions	crossSourceCollisions(boolean crossSourceCollisions) Enable cross-source symbol collision detection, defaults to true.
MapboxMapOptions	debugActive(boolean enabled) Specifies the used debug type for a map view.
int	describeContents()
MapboxMapOptions	doubleTapGesturesEnabled(boolean enabled) Specifies if the double tap gesture is enabled for a map view.
boolean	equals(java.lang.Object o)
MapboxMapOptions	foregroundLoadColor(int loadColor) Set the MapView foreground color that is used when the map surface is being created.
java.lang.String	getApiBaseUri() Get the current configured API endpoint base URI.
java.lang.String	getApiBaseUrl() Deprecated. use getApiBaseUri() instead
boolean	getAttributionEnabled() Get the current configured visibility state for attribution for a map view.
int	getAttributionGravity() Get the current configured gravity state for attribution for a map view.
int[]	getAttributionMargins() Get the current configured margins for attribution for a map view.
int	getAttributionTintColor() Get the current configured tint color for attribution for a map view.
CameraPosition	getCamera() Get the current configured initial camera position for a map view.
boolean	getCompassEnabled() Get the current configured visibility state for mapbox_compass_icon for a map view.
boolean	getCompassFadeFacingNorth() Get the current configured state for fading the mapbox_compass_icon when facing north.
int	getCompassGravity() Get the current configured gravity state for mapbox_compass_icon for a map view.
android.graphics.drawable.Drawable	getCompassImage() Deprecated.
int	getCompassImageResource() Get the current configured CompassView image resource id.
int[]	getCompassMargins() Get the current configured margins for mapbox_compass_icon for a map view.
boolean	getCrossSourceCollisions() Check whether cross-source symbol collision detection is enabled.
boolean	getDebugActive() Get the current configured debug state for a map view.
boolean	getDoubleTapGesturesEnabled() Get the current configured double tap gesture state for a map view.
int	getForegroundLoadColor() Returns the current configured foreground color that is used during map creation.
GlyphsRasterizationMode	getGlyphsRasterizationMode() Experimental.
boolean	getHorizontalScrollGesturesEnabled() Get the current configured horizontal scroll gesture state for a map view.
java.lang.String	getLocalIdeographFontFamily() Returns the font-family for locally overriding generation of glyphs in the 'CJK Unified Ideographs' and 'Hangul Syllables' ranges.
boolean	getLogoEnabled() Get the current configured visibility state for mapbox_compass_icon for a map view.
int	getLogoGravity() Get the current configured gravity state for logo for a map view.
int[]	getLogoMargins() Get the current configured margins for logo for a map view.
double	getMaxPitchPreference() Get the current configured maximum pitch for a map view.
double	getMaxZoomPreference() Get the current configured maximum zoom for a map view.
double	getMinPitchPreference() Get the current configured min pitch for a map view.
double	getMinZoomPreference() Get the current configured min zoom for a map view.
float	getPixelRatio() Return the custom configured pixel ratio, returns 0 if not configured.
boolean	getPrefetchesTiles() Deprecated. Use getPrefetchZoomDelta() instead.
int	getPrefetchZoomDelta() Check current pre-fetching zoom delta.
boolean	getQuickZoomGesturesEnabled() Get whether the user may zoom the map by tapping twice, holding and moving the pointer up and down.
boolean	getRenderSurfaceOnTop() Get the flag to render the map surface on top of another surface.
boolean	getRotateGesturesEnabled() Get the current configured rotate gesture state for a map view.
boolean	getScrollGesturesEnabled() Get the current configured scroll gesture state for a map view.
boolean	getTextureMode() Returns true if TextureView is being used the render view.
boolean	getTiltGesturesEnabled() Get the current configured tilt gesture state for a map view.
boolean	getTranslucentTextureSurface() Returns true if TextureView supports a translucent surface
boolean	getZoomGesturesEnabled() Get the current configured zoom gesture state for a map view.
int	hashCode()
MapboxMapOptions	horizontalScrollGesturesEnabled(boolean enabled) Specifies if the horizontal scroll gesture is enabled for a map view.
boolean	isLocalIdeographFontFamilyEnabled() Returns true if local ideograph font family is enabled, defaults to true.
MapboxMapOptions	localIdeographFontFamily(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.
MapboxMapOptions	localIdeographFontFamily(java.lang.String fontFamily) Set the font family for generating glyphs locally for ideographs in the 'CJK Unified Ideographs' and 'Hangul Syllables' ranges.
MapboxMapOptions	localIdeographFontFamilyEnabled(boolean enabled) Enable local ideograph font family, defaults to true.
MapboxMapOptions	logoEnabled(boolean enabled) Specifies the visibility state of a logo for a map view.
MapboxMapOptions	logoGravity(int gravity) Specifies the gravity state of logo for a map view.
MapboxMapOptions	logoMargins(int[] margins) Specifies the margin state of logo for a map view
MapboxMapOptions	maxPitchPreference(double maxPitch) Specifies the used maximum pitch for a map view.
MapboxMapOptions	maxZoomPreference(double maxZoom) Specifies the used maximum zoom level for a map view.
MapboxMapOptions	minPitchPreference(double minPitch) Specifies the used minimum pitch for a map view.
MapboxMapOptions	minZoomPreference(double minZoom) Specifies the used minimum zoom level for a map view.
MapboxMapOptions	pixelRatio(float pixelRatio) Set the custom pixel ratio configuration to override the default value from resources.
MapboxMapOptions	quickZoomGesturesEnabled(boolean enabled) Specifies whether the user may zoom the map by tapping twice, holding and moving the pointer up and down.
void	renderSurfaceOnTop(boolean renderOnTop) Set the flag to render the map surface on top of another surface.
MapboxMapOptions	rotateGesturesEnabled(boolean enabled) Specifies if the rotate gesture is enabled for a map view.
MapboxMapOptions	scrollGesturesEnabled(boolean enabled) Specifies if the scroll gesture is enabled for a map view.
MapboxMapOptions	setPrefetchesTiles(boolean enable) Deprecated. Use setPrefetchZoomDelta(int) instead.
MapboxMapOptions	setPrefetchZoomDelta(int delta) Set the tile pre-fetching zoom delta.
void	setRasterizationMode(GlyphsRasterizationMode glyphsRasterizationMode) Experimental.
MapboxMapOptions	textureMode(boolean textureMode) Enable TextureView as rendered surface.
MapboxMapOptions	tiltGesturesEnabled(boolean enabled) Specifies if the tilt gesture is enabled for a map view.
MapboxMapOptions	translucentTextureSurface(boolean translucentTextureSurface)
void	writeToParcel(android.os.Parcel dest, int flags)
MapboxMapOptions	zoomGesturesEnabled(boolean enabled) Specifies if the zoom gesture is enabled for a map view.

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<MapboxMapOptions> CREATOR

Constructor Detail

MapboxMapOptions

@Deprecated
public MapboxMapOptions()

Deprecated. Use createFromAttributes(Context, AttributeSet) instead.

Creates a new MapboxMapOptions object.

Method Detail

createFromAttributes

@NonNull
public static MapboxMapOptions createFromAttributes(@NonNull
                                                             android.content.Context context)

Creates a default MapboxMapsOptions from a given context.

Parameters:

context - Context related to a map view.

Returns:

the MapboxMapOptions created from attributes

createFromAttributes

@NonNull
public static MapboxMapOptions createFromAttributes(@NonNull
                                                             android.content.Context context,
                                                             @Nullable
                                                             android.util.AttributeSet attrs)

Creates a MapboxMapsOptions from the attribute set.

Parameters:

context - Context related to a map view.

attrs - Attributeset containing configuration

Returns:

the MapboxMapOptions created from attributes

setRasterizationMode

public void setRasterizationMode(GlyphsRasterizationMode glyphsRasterizationMode)

Experimental. Set glyphs rasterization mode for client-side text rendering.

Parameters:

glyphsRasterizationMode - the glyphs rasterization mode will be used.

getGlyphsRasterizationMode

public GlyphsRasterizationMode getGlyphsRasterizationMode()

Experimental. Glyphs rasterization mode for client-side text rendering.

Returns:

the glyphs rasterization mode.

apiBaseUrl

@Deprecated
 @NonNull
public MapboxMapOptions apiBaseUrl(java.lang.String apiBaseUrl)

Deprecated. use apiBaseUri instead

Specifies the URL used for API endpoint.

Parameters:

apiBaseUrl - The base of our API endpoint

Returns:

This

apiBaseUri

@NonNull
public MapboxMapOptions apiBaseUri(java.lang.String apiBaseUri)

Specifies the URI used for API endpoint.

Parameters:

apiBaseUri - The base of our API endpoint

Returns:

This

camera

@NonNull
public MapboxMapOptions camera(CameraPosition cameraPosition)

Specifies a the initial camera position for the map view.

Parameters:

cameraPosition - Inital camera position

Returns:

This

debugActive

@NonNull
public MapboxMapOptions debugActive(boolean enabled)

Specifies the used debug type for a map view.

Parameters:

enabled - True is debug is enabled

Returns:

This

minZoomPreference

@NonNull
public MapboxMapOptions minZoomPreference(double minZoom)

Specifies the used minimum zoom level for a map view.

Parameters:

minZoom - Zoom level to be used

Returns:

This

maxZoomPreference

@NonNull
public MapboxMapOptions maxZoomPreference(double maxZoom)

Specifies the used maximum zoom level for a map view.

Parameters:

maxZoom - Zoom level to be used

Returns:

This

minPitchPreference

@NonNull
public MapboxMapOptions minPitchPreference(double minPitch)

Specifies the used minimum pitch for a map view.

Parameters:

minPitch - Pitch to be used

Returns:

This

maxPitchPreference

@NonNull
public MapboxMapOptions maxPitchPreference(double maxPitch)

Specifies the used maximum pitch for a map view.

Parameters:

maxPitch - Pitch to be used

Returns:

This

compassEnabled

@NonNull
public MapboxMapOptions compassEnabled(boolean enabled)

Specifies the visibility state of a mapbox_compass_icon for a map view.

Parameters:

enabled - True and mapbox_compass_icon is shown

Returns:

This

compassGravity

@NonNull
public MapboxMapOptions compassGravity(int gravity)

Specifies the gravity state of mapbox_compass_icon for a map view.

Parameters:

gravity - Android SDK Gravity.

Returns:

This

compassMargins

@NonNull
public MapboxMapOptions compassMargins(int[] margins)

Specifies the margin state of mapbox_compass_icon for a map view

Parameters:

margins - 4 long array for LTRB margins

Returns:

This

compassFadesWhenFacingNorth

@NonNull
public MapboxMapOptions compassFadesWhenFacingNorth(boolean compassFadeWhenFacingNorth)

Specifies if the mapbox_compass_icon fades to invisible when facing north.

By default this value is true.

Parameters:

compassFadeWhenFacingNorth - true is mapbox_compass_icon fades to invisble

Returns:

This

compassImage

@NonNull
public MapboxMapOptions compassImage(android.graphics.drawable.Drawable compass)

Deprecated. use compassImageResource instead

Specifies the image of the CompassView.

By default this value is R.drawable.mapbox_compass_icon.

Parameters:

compass - the drawable to show as image compass

Returns:

This

compassImageResource

@NonNull
public MapboxMapOptions compassImageResource(@DrawableRes
                                                      int compassImageResource)

Specifies the image of the CompassView.

By default this value is R.drawable.mapbox_compass_icon.

Parameters:

compassImageResource - the drawable resource id to show as image compass

Returns:

This

logoEnabled

@NonNull
public MapboxMapOptions logoEnabled(boolean enabled)

Specifies the visibility state of a logo for a map view.

Parameters:

enabled - True and logo is shown

Returns:

This

logoGravity

@NonNull
public MapboxMapOptions logoGravity(int gravity)

Specifies the gravity state of logo for a map view.

Parameters:

gravity - Android SDK Gravity.

Returns:

This

logoMargins

@NonNull
public MapboxMapOptions logoMargins(int[] margins)

Specifies the margin state of logo for a map view

Parameters:

margins - 4 long array for LTRB margins

Returns:

This

attributionEnabled

@NonNull
public MapboxMapOptions attributionEnabled(boolean enabled)

Specifies the visibility state of a attribution for a map view.

Parameters:

enabled - True and attribution is shown

Returns:

This

attributionGravity

@NonNull
public MapboxMapOptions attributionGravity(int gravity)

Specifies the gravity state of attribution for a map view.

Parameters:

gravity - Android SDK Gravity.

Returns:

This

attributionMargins

@NonNull
public MapboxMapOptions attributionMargins(int[] margins)

Specifies the margin state of attribution for a map view

Parameters:

margins - 4 long array for LTRB margins

Returns:

This

attributionTintColor

@NonNull
public MapboxMapOptions attributionTintColor(@ColorInt
                                                      int color)

Specifies the tint color of the attribution for a map view

Parameters:

color - integer resembling a color

Returns:

This

rotateGesturesEnabled

@NonNull
public MapboxMapOptions rotateGesturesEnabled(boolean enabled)

Specifies if the rotate gesture is enabled for a map view.

Parameters:

enabled - True and gesture will be enabled

Returns:

This

scrollGesturesEnabled

@NonNull
public MapboxMapOptions scrollGesturesEnabled(boolean enabled)

Specifies if the scroll gesture is enabled for a map view.

Parameters:

enabled - True and gesture will be enabled

Returns:

This

horizontalScrollGesturesEnabled

@NonNull
public MapboxMapOptions horizontalScrollGesturesEnabled(boolean enabled)

Specifies if the horizontal scroll gesture is enabled for a map view.

Parameters:

enabled - True and gesture will be enabled

Returns:

This

tiltGesturesEnabled

@NonNull
public MapboxMapOptions tiltGesturesEnabled(boolean enabled)

Specifies if the tilt gesture is enabled for a map view.

Parameters:

enabled - True and gesture will be enabled

Returns:

This

zoomGesturesEnabled

@NonNull
public MapboxMapOptions zoomGesturesEnabled(boolean enabled)

Specifies if the zoom gesture is enabled for a map view.

Parameters:

enabled - True and gesture will be enabled

Returns:

This

doubleTapGesturesEnabled

@NonNull
public MapboxMapOptions doubleTapGesturesEnabled(boolean enabled)

Specifies if the double tap gesture is enabled for a map view.

Parameters:

enabled - True and gesture will be enabled

Returns:

This

quickZoomGesturesEnabled

@NonNull
public MapboxMapOptions quickZoomGesturesEnabled(boolean enabled)

Specifies whether the user may zoom the map by tapping twice, holding and moving the pointer up and down.

Parameters:

enabled - True and gesture will be enabled

Returns:

This

textureMode

@NonNull
public MapboxMapOptions textureMode(boolean textureMode)

Enable TextureView as rendered surface.

Since the 5.2.0 release we replaced our TextureView with an GLSurfaceView implementation. Enabling this option will use the TextureView instead. TextureView can be useful in situations where you need to animate, scale or transform the view. This comes at a siginficant performance penalty and should not be considered unless absolutely needed.

Parameters:

textureMode - True to enable texture mode

Returns:

This

translucentTextureSurface

@NonNull
public MapboxMapOptions translucentTextureSurface(boolean translucentTextureSurface)

foregroundLoadColor

@NonNull
public MapboxMapOptions foregroundLoadColor(@ColorInt
                                                     int loadColor)

Set the MapView foreground color that is used when the map surface is being created.

Parameters:

loadColor - the color to show during map creation

Returns:

This

setPrefetchesTiles

@Deprecated
 @NonNull
public MapboxMapOptions setPrefetchesTiles(boolean enable)

Deprecated. Use setPrefetchZoomDelta(int) instead.

Enable tile pre-fetching. Loads tiles at a lower zoom-level to pre-render a low resolution preview while more detailed tiles are loaded. Enabled by default

Parameters:

enable - true to enable

Returns:

This

setPrefetchZoomDelta

@NonNull
public MapboxMapOptions setPrefetchZoomDelta(@IntRange(from=0L)
                                                      int delta)

Set the tile pre-fetching zoom delta. Pre-fetching makes sure that a low-resolution tile at the (current_zoom_level - delta) is rendered as soon as possible at the expense of a little bandwidth. Note: This operation will override the MapboxMapOptions#setPrefetchesTiles(boolean) Setting zoom delta to 0 will disable pre-fetching. Default zoom delta is 4.

Parameters:

delta - zoom delta

Returns:

This

crossSourceCollisions

@NonNull
public MapboxMapOptions crossSourceCollisions(boolean crossSourceCollisions)

Enable cross-source symbol collision detection, defaults to true.

If set to false, symbol layers will only run collision detection against other symbol layers that are part of the same source.

Parameters:

crossSourceCollisions - true to enable, false to disable

Returns:

This

localIdeographFontFamilyEnabled

@NonNull
public MapboxMapOptions localIdeographFontFamilyEnabled(boolean enabled)

Enable local ideograph font family, defaults to true.

Parameters:

enabled - true to enable, false to disable

Returns:

This

localIdeographFontFamily

@NonNull
public MapboxMapOptions localIdeographFontFamily(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:

This

localIdeographFontFamily

@NonNull
public MapboxMapOptions localIdeographFontFamily(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 first matching font will be selected. If no valid font found, it defaults to MapboxConstants.DEFAULT_FONT.

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 - an array of font families for local ideograph generation.

Returns:

This

pixelRatio

@NonNull
public MapboxMapOptions pixelRatio(float pixelRatio)

Set the custom pixel ratio configuration to override the default value from resources. This ratio will be used to initialise the map with.

Parameters:

pixelRatio - the custom pixel ratio of the map under construction

Returns:

This

getPrefetchesTiles

@Deprecated
public boolean getPrefetchesTiles()

Deprecated. Use getPrefetchZoomDelta() instead.

Check whether tile pre-fetching is enabled.

Returns:

true if enabled

getPrefetchZoomDelta

@IntRange(from=0L)
public int getPrefetchZoomDelta()

Check current pre-fetching zoom delta.

Returns:

current zoom delta.

getCrossSourceCollisions

public boolean getCrossSourceCollisions()

Check whether cross-source symbol collision detection is enabled.

Returns:

true if enabled

renderSurfaceOnTop

public void renderSurfaceOnTop(boolean renderOnTop)

Set the flag to render the map surface on top of another surface.

Parameters:

renderOnTop - true if this map is shown on top of another one, false if bottom.

getRenderSurfaceOnTop

public boolean getRenderSurfaceOnTop()

Get the flag to render the map surface on top of another surface.

Returns:

true if this map is

getApiBaseUrl

@Deprecated
public java.lang.String getApiBaseUrl()

Deprecated. use getApiBaseUri() instead

Get the current configured API endpoint base URL.

Returns:

Base URL to be used API endpoint.

getApiBaseUri

public java.lang.String getApiBaseUri()

Get the current configured API endpoint base URI.

Returns:

Base URI to be used API endpoint.

getCamera

public CameraPosition getCamera()

Get the current configured initial camera position for a map view.

Returns:

CameraPosition to be initially used.

getMinZoomPreference

public double getMinZoomPreference()

Get the current configured min zoom for a map view.

Returns:

Mininum zoom level to be used.

getMaxZoomPreference

public double getMaxZoomPreference()

Get the current configured maximum zoom for a map view.

Returns:

Maximum zoom to be used.

getMinPitchPreference

public double getMinPitchPreference()

Get the current configured min pitch for a map view.

Returns:

Mininum pitch to be used.

getMaxPitchPreference

public double getMaxPitchPreference()

Get the current configured maximum pitch for a map view.

Returns:

Maximum pitch to be used.

getCompassEnabled

public boolean getCompassEnabled()

Get the current configured visibility state for mapbox_compass_icon for a map view.

Returns:

Visibility state of the mapbox_compass_icon

getCompassGravity

public int getCompassGravity()

Get the current configured gravity state for mapbox_compass_icon for a map view.

Returns:

Gravity state of the mapbox_compass_icon

getCompassMargins

public int[] getCompassMargins()

Get the current configured margins for mapbox_compass_icon for a map view.

Returns:

Margins state of the mapbox_compass_icon

getCompassFadeFacingNorth

public boolean getCompassFadeFacingNorth()

Get the current configured state for fading the mapbox_compass_icon when facing north.

Returns:

True if mapbox_compass_icon fades to invisible when facing north

getCompassImage

@Deprecated
public android.graphics.drawable.Drawable getCompassImage()

Deprecated.

Get the current configured CompassView image.

Returns:

the drawable used as compass image

getCompassImageResource

@DrawableRes
public int getCompassImageResource()

Get the current configured CompassView image resource id.

Returns:

the resource id of the used as compass image

getLogoEnabled

public boolean getLogoEnabled()

Get the current configured visibility state for mapbox_compass_icon for a map view.

Returns:

Visibility state of the mapbox_compass_icon

getLogoGravity

public int getLogoGravity()

Get the current configured gravity state for logo for a map view.

Returns:

Gravity state of the logo

getLogoMargins

public int[] getLogoMargins()

Get the current configured margins for logo for a map view.

Returns:

Margins state of the logo

getRotateGesturesEnabled

public boolean getRotateGesturesEnabled()

Get the current configured rotate gesture state for a map view.

Returns:

True indicates gesture is enabled

getScrollGesturesEnabled

public boolean getScrollGesturesEnabled()

Get the current configured scroll gesture state for a map view.

Returns:

True indicates gesture is enabled

getHorizontalScrollGesturesEnabled

public boolean getHorizontalScrollGesturesEnabled()

Get the current configured horizontal scroll gesture state for a map view.

Returns:

True indicates horizontal scroll gesture is enabled

getTiltGesturesEnabled

public boolean getTiltGesturesEnabled()

Get the current configured tilt gesture state for a map view.

Returns:

True indicates gesture is enabled

getZoomGesturesEnabled

public boolean getZoomGesturesEnabled()

Get the current configured zoom gesture state for a map view.

Returns:

True indicates gesture is enabled

getDoubleTapGesturesEnabled

public boolean getDoubleTapGesturesEnabled()

Get the current configured double tap gesture state for a map view.

Returns:

True indicates gesture is enabled

getQuickZoomGesturesEnabled

public boolean getQuickZoomGesturesEnabled()

Get whether the user may zoom the map by tapping twice, holding and moving the pointer up and down.

Returns:

True indicates gesture is enabled

getAttributionEnabled

public boolean getAttributionEnabled()

Get the current configured visibility state for attribution for a map view.

Returns:

Visibility state of the attribution

getAttributionGravity

public int getAttributionGravity()

Get the current configured gravity state for attribution for a map view.

Returns:

Gravity state of the logo

getAttributionMargins

public int[] getAttributionMargins()

Get the current configured margins for attribution for a map view.

Returns:

Margins state of the logo

getAttributionTintColor

@ColorInt
public int getAttributionTintColor()

Get the current configured tint color for attribution for a map view.

Returns:

the tint color

getDebugActive

public boolean getDebugActive()

Get the current configured debug state for a map view.

Returns:

True indicates debug is enabled.

getTextureMode

public boolean getTextureMode()

Returns true if TextureView is being used the render view.

Returns:

True if TextureView is used.

getTranslucentTextureSurface

public boolean getTranslucentTextureSurface()

Returns true if TextureView supports a translucent surface

Returns:

True if translucent surface is active

getForegroundLoadColor

@ColorInt
public int getForegroundLoadColor()

Returns the current configured foreground color that is used during map creation.

Returns:

the load color

getLocalIdeographFontFamily

@Nullable
public java.lang.String getLocalIdeographFontFamily()

Returns the font-family for locally overriding generation of glyphs in the 'CJK Unified Ideographs' and 'Hangul Syllables' ranges. Default font for local ideograph font family is MapboxConstants.DEFAULT_FONT. Returns null if local ideograph font families are disabled.

Returns:

Local ideograph font family name.

isLocalIdeographFontFamilyEnabled

public boolean isLocalIdeographFontFamilyEnabled()

Returns true if local ideograph font family is enabled, defaults to true.

Returns:

True if local ideograph font family is enabled

getPixelRatio

public float getPixelRatio()

Return the custom configured pixel ratio, returns 0 if not configured.

Returns:

the pixel ratio used by the map under construction

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(@NonNull
                          android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

equals

public boolean equals(@Nullable
                      java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object