public class MapboxMapOptions
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static <any> |
CREATOR |
Constructor and Description |
---|
MapboxMapOptions()
Creates a new MapboxMapOptions object.
|
Modifier and Type | Method and Description |
---|---|
MapboxMapOptions |
apiBaseUrl(java.lang.String apiBaseUrl)
Specifies the URL used for API endpoint.
|
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(Drawable compass)
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(Context context,
AttributeSet attrs)
Creates a MapboxMapsOptions from the attribute set.s
|
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 |
getApiBaseUrl()
Get the current configured API endpoint base URL.
|
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.
|
Drawable |
getCompassImage()
Get the current configured CompassView image.
|
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.
|
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 |
getMaxZoomPreference()
Get the current configured maximum zoom 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()
Check whether tile pre-fetching is enabled.
|
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() |
boolean |
getZoomGesturesEnabled()
Get the current configured zoom gesture state for a map view.
|
int |
hashCode() |
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 |
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 |
maxZoomPreference(double maxZoom)
Specifies the used maximum zoom level 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.
|
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)
Enable tile pre-fetching.
|
MapboxMapOptions |
textureMode(boolean textureMode)
Enable
android.view.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(Parcel dest,
int flags) |
MapboxMapOptions |
zoomGesturesEnabled(boolean enabled)
Specifies if the zoom gesture is enabled for a map view.
|
public MapboxMapOptions()
public static MapboxMapOptions createFromAttributes(Context context, AttributeSet attrs)
context
- Context related to a map view.attrs
- Attributeset containing configurationpublic MapboxMapOptions apiBaseUrl(java.lang.String apiBaseUrl)
apiBaseUrl
- The base of our API endpointpublic MapboxMapOptions camera(CameraPosition cameraPosition)
cameraPosition
- Inital camera positionpublic MapboxMapOptions debugActive(boolean enabled)
enabled
- True is debug is enabledpublic MapboxMapOptions minZoomPreference(double minZoom)
minZoom
- Zoom level to be usedpublic MapboxMapOptions maxZoomPreference(double maxZoom)
maxZoom
- Zoom level to be usedpublic MapboxMapOptions compassEnabled(boolean enabled)
enabled
- True and mapbox_compass_icon is shownpublic MapboxMapOptions compassGravity(int gravity)
gravity
- Android SDK Gravity.public MapboxMapOptions compassMargins(int[] margins)
margins
- 4 long array for LTRB marginspublic MapboxMapOptions compassFadesWhenFacingNorth(boolean compassFadeWhenFacingNorth)
By default this value is true.
compassFadeWhenFacingNorth
- true is mapbox_compass_icon fades to invisblepublic MapboxMapOptions compassImage(Drawable compass)
By default this value is R.drawable.mapbox_compass_icon.
compass
- the drawable to show as image compasspublic MapboxMapOptions logoEnabled(boolean enabled)
enabled
- True and logo is shownpublic MapboxMapOptions logoGravity(int gravity)
gravity
- Android SDK Gravity.public MapboxMapOptions logoMargins(int[] margins)
margins
- 4 long array for LTRB marginspublic MapboxMapOptions attributionEnabled(boolean enabled)
enabled
- True and attribution is shownpublic MapboxMapOptions attributionGravity(int gravity)
gravity
- Android SDK Gravity.public MapboxMapOptions attributionMargins(int[] margins)
margins
- 4 long array for LTRB marginspublic MapboxMapOptions attributionTintColor(int color)
color
- integer resembling a colorpublic MapboxMapOptions rotateGesturesEnabled(boolean enabled)
enabled
- True and gesture will be enabledpublic MapboxMapOptions scrollGesturesEnabled(boolean enabled)
enabled
- True and gesture will be enabledpublic MapboxMapOptions tiltGesturesEnabled(boolean enabled)
enabled
- True and gesture will be enabledpublic MapboxMapOptions zoomGesturesEnabled(boolean enabled)
enabled
- True and gesture will be enabledpublic MapboxMapOptions doubleTapGesturesEnabled(boolean enabled)
enabled
- True and gesture will be enabledpublic MapboxMapOptions textureMode(boolean textureMode)
android.view.TextureView
as rendered surface.
Since the 5.2.0 release we replaced our TextureView with an android.opengl.GLSurfaceView
implementation. Enabling this option will use the android.view.TextureView
instead.
android.view.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.
textureMode
- True to enable texture modepublic MapboxMapOptions translucentTextureSurface(boolean translucentTextureSurface)
public MapboxMapOptions foregroundLoadColor(int loadColor)
loadColor
- the color to show during map creationpublic MapboxMapOptions setPrefetchesTiles(boolean enable)
enable
- true to enablepublic MapboxMapOptions crossSourceCollisions(boolean crossSourceCollisions)
If set to false, symbol layers will only run collision detection against other symbol layers that are part of the same source.
crossSourceCollisions
- true to enable, false to disablepublic MapboxMapOptions localIdeographFontFamily(java.lang.String fontFamily)
The font family argument is passed to android.graphics.Typeface#create(String, int)
.
Default system fonts are defined in '/system/etc/fonts.xml'
fontFamily
- font family for local ideograph generation.public MapboxMapOptions pixelRatio(float pixelRatio)
pixelRatio
- the custom pixel ratio of the map under constructionpublic boolean getPrefetchesTiles()
public boolean getCrossSourceCollisions()
public void renderSurfaceOnTop(boolean renderOnTop)
renderOnTop
- true if this map is shown on top of another one, false if bottom.public boolean getRenderSurfaceOnTop()
public java.lang.String getApiBaseUrl()
public CameraPosition getCamera()
public double getMinZoomPreference()
public double getMaxZoomPreference()
public boolean getCompassEnabled()
public int getCompassGravity()
public int[] getCompassMargins()
public boolean getCompassFadeFacingNorth()
public Drawable getCompassImage()
public boolean getLogoEnabled()
public int getLogoGravity()
public int[] getLogoMargins()
public boolean getRotateGesturesEnabled()
public boolean getScrollGesturesEnabled()
public boolean getTiltGesturesEnabled()
public boolean getZoomGesturesEnabled()
public boolean getDoubleTapGesturesEnabled()
public boolean getAttributionEnabled()
public int getAttributionGravity()
public int[] getAttributionMargins()
public int getAttributionTintColor()
public boolean getDebugActive()
public boolean getTextureMode()
public boolean getTranslucentTextureSurface()
public int getForegroundLoadColor()
public java.lang.String getLocalIdeographFontFamily()
public float getPixelRatio()
public int describeContents()
public void writeToParcel(Parcel dest, int flags)
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
© 2015–2019 Mapbox. All rights reserved.