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() Creates a new MapboxMapOptions object.

Method Summary

Modifier and Type	Method and Description
MapboxMapOptions	accessToken(java.lang.String accessToken) Specifies the accesstoken associated with a map view.
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	camera(CameraPosition cameraPosition) Specifies a the initial camera position for the map view.
MapboxMapOptions	compassEnabled(boolean enabled) Specifies the visibility state of a compass for a map view.
MapboxMapOptions	compassGravity(int gravity) Specifies the gravity state of compass for a map view.
MapboxMapOptions	compassMargins(int[] margins) Specifies the margin state of compass for a map view
static MapboxMapOptions	createFromAttributes(android.content.Context context, android.util.AttributeSet attrs) Creates a GoogleMapsOptions from the attribute set
MapboxMapOptions	debugActive(boolean enabled) Specifies the used debug type for a map view.
int	describeContents()
java.lang.String	getAccessToken() Get the current configured access token for a map view.
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.
CameraPosition	getCamera() Get the current configured initial camera position for a map view.
boolean	getCompassEnabled() Get the current configured visibility state for compass for a map view.
int	getCompassGravity() Get the current configured gravity state for compass for a map view.
int[]	getCompassMargins() Get the current configured margins for compass for a map view.
boolean	getDebugActive() Get the current configured debug state for a map view.
boolean	getLocationEnabled() Get the current configured user location view state for a map view.
boolean	getLogoEnabled() Get the current configured visibility state for compass 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.
float	getMaxZoom() Get the current configured maximum zoom for a map view.
float	getMinZoom() Get the current configured min zoom for a map view.
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.
java.lang.String	getStyle() Get the current configured style url for a map view.
boolean	getTiltGesturesEnabled() Get the current configured tilt gesture state for a map view.
boolean	getZoomControlsEnabled() Get the current configured zoom controls state for a map view.
boolean	getZoomGesturesEnabled() Get the current configured zoom gesture state for a map view.
MapboxMapOptions	locationEnabled(boolean locationEnabled) Specifies if the user location view is enabled for a map view.
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	maxZoom(float maxZoom) Specifies the used maximum zoom level for a map view.
MapboxMapOptions	minZoom(float minZoom) Specifies the used minimum zoom level for a map view.
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	styleUrl(java.lang.String styleUrl) Specifies the style url associated with a map view.
MapboxMapOptions	tiltGesturesEnabled(boolean enabled) Specifies if the tilt gesture is enabled for a map view.
void	writeToParcel(android.os.Parcel dest, int flags)
MapboxMapOptions	zoomControlsEnabled(boolean enabled) Specifies if the zoom controls are enabled for a map view.
MapboxMapOptions	zoomGesturesEnabled(boolean enabled) Specifies if the zoom gesture is enabled for a map view.

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

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

Constructor Detail

MapboxMapOptions

public MapboxMapOptions()

Creates a new MapboxMapOptions object.

Method Detail

createFromAttributes

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

Creates a GoogleMapsOptions from the attribute set

Parameters:

context - Context related to a map view.

attrs - Attributeset containing configuration

Returns:

camera

public MapboxMapOptions camera(CameraPosition cameraPosition)

Specifies a the initial camera position for the map view.

Parameters:

cameraPosition - Inital camera position

Returns:

This

accessToken

public MapboxMapOptions accessToken(java.lang.String accessToken)

Specifies the accesstoken associated with a map view.

Parameters:

accessToken - Token to be used to access the service

Returns:

This

styleUrl

public MapboxMapOptions styleUrl(java.lang.String styleUrl)

Specifies the style url associated with a map view.

Parameters:

styleUrl - Url to be used to load a style

Returns:

This

debugActive

public MapboxMapOptions debugActive(boolean enabled)

Specifies the used debug type for a map view.

Parameters:

enabled - True is debug is enabled

Returns:

This

minZoom

public MapboxMapOptions minZoom(float minZoom)

Specifies the used minimum zoom level for a map view.

Parameters:

minZoom - Zoom level to be used

Returns:

This

maxZoom

public MapboxMapOptions maxZoom(float maxZoom)

Specifies the used maximum zoom level for a map view.

Parameters:

maxZoom - Zoom level to be used

Returns:

This

compassEnabled

public MapboxMapOptions compassEnabled(boolean enabled)

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

Parameters:

enabled - True and compass is shown

Returns:

This

compassGravity

public MapboxMapOptions compassGravity(int gravity)

Specifies the gravity state of compass for a map view.

Parameters:

gravity - see Gravity

Returns:

This

compassMargins

public MapboxMapOptions compassMargins(int[] margins)

Specifies the margin state of compass for a map view

Parameters:

margins - 4 long array for LTRB margins

Returns:

This

logoEnabled

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

public MapboxMapOptions logoGravity(int gravity)

Specifies the gravity state of logo for a map view.

Parameters:

gravity - see Gravity

Returns:

This

logoMargins

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

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

public MapboxMapOptions attributionGravity(int gravity)

Specifies the gravity state of attribution for a map view.

Parameters:

gravity - see Gravity

Returns:

This

attributionMargins

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

rotateGesturesEnabled

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

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

tiltGesturesEnabled

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

zoomControlsEnabled

public MapboxMapOptions zoomControlsEnabled(boolean enabled)

Specifies if the zoom controls are enabled for a map view.

Parameters:

enabled - True and gesture will be enabled

Returns:

This

zoomGesturesEnabled

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

locationEnabled

public MapboxMapOptions locationEnabled(boolean locationEnabled)

Specifies if the user location view is enabled for a map view.

Parameters:

locationEnabled - True and gesture will be enabled

Returns:

This

getCamera

public CameraPosition getCamera()

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

Returns:

CameraPosition to be initially used.

getMinZoom

public float getMinZoom()

Get the current configured min zoom for a map view.

Returns:

Mininum zoom level to be used.

getMaxZoom

public float getMaxZoom()

Get the current configured maximum zoom for a map view.

Returns:

Maximum zoom to be used.

getCompassEnabled

public boolean getCompassEnabled()

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

Returns:

Visibility state of the compass

getCompassGravity

public int getCompassGravity()

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

Returns:

Gravity state of the compass

getCompassMargins

public int[] getCompassMargins()

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

Returns:

Margins state of the compass

getLogoEnabled

public boolean getLogoEnabled()

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

Returns:

Visibility state of the compass

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

getAccessToken

public java.lang.String getAccessToken()

Get the current configured access token for a map view.

Returns:

Access token to be used.

getStyle

public java.lang.String getStyle()

Get the current configured style url for a map view.

Returns:

Style url to be used.

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

getTiltGesturesEnabled

public boolean getTiltGesturesEnabled()

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

Returns:

True indicates gesture is enabled

getZoomControlsEnabled

public boolean getZoomControlsEnabled()

Get the current configured zoom controls 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

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

getLocationEnabled

public boolean getLocationEnabled()

Get the current configured user location view state for a map view.

Returns:

True and user location will be shown

getDebugActive

public boolean getDebugActive()

Get the current configured debug state for a map view.

Returns:

True indicates debug is enabled.

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

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

Specified by:

writeToParcel in interface android.os.Parcelable