public class DingiMapOptions
extends java.lang.Object
implements android.os.Parcelable
Modifier and Type | Field and Description |
---|---|
static android.os.Parcelable.Creator<DingiMapOptions> |
CREATOR |
Constructor and Description |
---|
DingiMapOptions()
Creates a new DingiMapOptions object.
|
Modifier and Type | Method and Description |
---|---|
DingiMapOptions |
apiBaseUrl(java.lang.String apiBaseUrl)
Specifies the URL used for API endpoint.
|
DingiMapOptions |
attributionEnabled(boolean enabled)
Specifies the visibility state of a attribution for a map view.
|
DingiMapOptions |
attributionGravity(int gravity)
Specifies the gravity state of attribution for a map view.
|
DingiMapOptions |
attributionMargins(int[] margins)
Specifies the margin state of attribution for a map view
|
DingiMapOptions |
attributionTintColor(int color)
Specifies the tint color of the attribution for a map view
|
DingiMapOptions |
camera(CameraPosition cameraPosition)
Specifies a the initial camera position for the map view.
|
DingiMapOptions |
compassEnabled(boolean enabled)
Specifies the visibility state of a compass_icon for a map view.
|
DingiMapOptions |
compassFadesWhenFacingNorth(boolean compassFadeWhenFacingNorth)
Specifies if the compass_icon fades to invisible when facing north.
|
DingiMapOptions |
compassGravity(int gravity)
Specifies the gravity state of compass_icon for a map view.
|
DingiMapOptions |
compassImage(android.graphics.drawable.Drawable compass)
Specifies the image of the CompassView.
|
DingiMapOptions |
compassMargins(int[] margins)
Specifies the margin state of compass_icon for a map view
|
static DingiMapOptions |
createFromAttributes(android.content.Context context,
android.util.AttributeSet attrs)
Creates a DingiMapsOptions from the attribute set.s
|
DingiMapOptions |
crossSourceCollisions(boolean crossSourceCollisions)
Enable cross-source symbol collision detection, defaults to true.
|
DingiMapOptions |
debugActive(boolean enabled)
Specifies the used debug type for a map view.
|
int |
describeContents() |
DingiMapOptions |
doubleTapGesturesEnabled(boolean enabled)
Specifies if the double tap gesture is enabled for a map view.
|
boolean |
equals(java.lang.Object o) |
DingiMapOptions |
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 compass_icon for a map view.
|
boolean |
getCompassFadeFacingNorth()
Get the current configured state for fading the compass_icon when facing north.
|
int |
getCompassGravity()
Get the current configured gravity state for compass_icon for a map view.
|
android.graphics.drawable.Drawable |
getCompassImage()
Get the current configured CompassView image.
|
int[] |
getCompassMargins()
Get the current configured margins for 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 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.
|
java.lang.String |
getStyleJson()
Get the current configured styleJson for a map view.
|
java.lang.String |
getStyleUrl()
Get the current configured styleUrl url 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() |
DingiMapOptions |
localIdeographFontFamily(java.lang.String fontFamily)
Set the font family for generating glyphs locally for ideographs in the 'CJK Unified Ideographs'
and 'Hangul Syllables' ranges.
|
DingiMapOptions |
logoEnabled(boolean enabled)
Specifies the visibility state of a logo for a map view.
|
DingiMapOptions |
logoGravity(int gravity)
Specifies the gravity state of logo for a map view.
|
DingiMapOptions |
logoMargins(int[] margins)
Specifies the margin state of logo for a map view
|
DingiMapOptions |
maxZoomPreference(double maxZoom)
Specifies the used maximum zoom level for a map view.
|
DingiMapOptions |
minZoomPreference(double minZoom)
Specifies the used minimum zoom level for a map view.
|
DingiMapOptions |
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.
|
DingiMapOptions |
rotateGesturesEnabled(boolean enabled)
Specifies if the rotate gesture is enabled for a map view.
|
DingiMapOptions |
scrollGesturesEnabled(boolean enabled)
Specifies if the scroll gesture is enabled for a map view.
|
DingiMapOptions |
setPrefetchesTiles(boolean enable)
Enable tile pre-fetching.
|
DingiMapOptions |
styleJson(java.lang.String styleJson)
Specifies the styleJson associated with a map view.
|
DingiMapOptions |
styleUrl(java.lang.String styleUrl)
Specifies the styleUrl url associated with a map view.
|
DingiMapOptions |
textureMode(boolean textureMode)
Enable
TextureView as rendered surface. |
DingiMapOptions |
tiltGesturesEnabled(boolean enabled)
Specifies if the tilt gesture is enabled for a map view.
|
DingiMapOptions |
translucentTextureSurface(boolean translucentTextureSurface) |
void |
writeToParcel(android.os.Parcel dest,
int flags) |
DingiMapOptions |
zoomGesturesEnabled(boolean enabled)
Specifies if the zoom gesture is enabled for a map view.
|
public static final android.os.Parcelable.Creator<DingiMapOptions> CREATOR
@NonNull public static DingiMapOptions createFromAttributes(@NonNull android.content.Context context, @Nullable android.util.AttributeSet attrs)
context
- Context related to a map view.attrs
- Attributeset containing configuration@NonNull public DingiMapOptions apiBaseUrl(java.lang.String apiBaseUrl)
apiBaseUrl
- The base of our API endpoint@NonNull public DingiMapOptions camera(CameraPosition cameraPosition)
cameraPosition
- Inital camera position@NonNull public DingiMapOptions styleUrl(java.lang.String styleUrl)
styleUrl
- Url to be used to load a styleUrl@NonNull public DingiMapOptions styleJson(java.lang.String styleJson)
styleJson
- json to used as style@NonNull public DingiMapOptions debugActive(boolean enabled)
enabled
- True is debug is enabled@NonNull public DingiMapOptions minZoomPreference(double minZoom)
minZoom
- Zoom level to be used@NonNull public DingiMapOptions maxZoomPreference(double maxZoom)
maxZoom
- Zoom level to be used@NonNull public DingiMapOptions compassEnabled(boolean enabled)
enabled
- True and compass_icon is shown@NonNull public DingiMapOptions compassGravity(int gravity)
gravity
- Android SDK Gravity.@NonNull public DingiMapOptions compassMargins(int[] margins)
margins
- 4 long array for LTRB margins@NonNull public DingiMapOptions compassFadesWhenFacingNorth(boolean compassFadeWhenFacingNorth)
By default this value is true.
compassFadeWhenFacingNorth
- true is compass_icon fades to invisble@NonNull public DingiMapOptions compassImage(android.graphics.drawable.Drawable compass)
By default this value is R.drawable.compass_icon.
compass
- the drawable to show as image compass@NonNull public DingiMapOptions logoEnabled(boolean enabled)
enabled
- True and logo is shown@NonNull public DingiMapOptions logoGravity(int gravity)
gravity
- Android SDK Gravity.@NonNull public DingiMapOptions logoMargins(int[] margins)
margins
- 4 long array for LTRB margins@NonNull public DingiMapOptions attributionEnabled(boolean enabled)
enabled
- True and attribution is shown@NonNull public DingiMapOptions attributionGravity(int gravity)
gravity
- Android SDK Gravity.@NonNull public DingiMapOptions attributionMargins(int[] margins)
margins
- 4 long array for LTRB margins@NonNull public DingiMapOptions attributionTintColor(int color)
color
- integer resembling a color@NonNull public DingiMapOptions rotateGesturesEnabled(boolean enabled)
enabled
- True and gesture will be enabled@NonNull public DingiMapOptions scrollGesturesEnabled(boolean enabled)
enabled
- True and gesture will be enabled@NonNull public DingiMapOptions tiltGesturesEnabled(boolean enabled)
enabled
- True and gesture will be enabled@NonNull public DingiMapOptions zoomGesturesEnabled(boolean enabled)
enabled
- True and gesture will be enabled@NonNull public DingiMapOptions doubleTapGesturesEnabled(boolean enabled)
enabled
- True and gesture will be enabled@NonNull public DingiMapOptions textureMode(boolean textureMode)
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.
textureMode
- True to enable texture mode@NonNull public DingiMapOptions translucentTextureSurface(boolean translucentTextureSurface)
@NonNull public DingiMapOptions foregroundLoadColor(int loadColor)
loadColor
- the color to show during map creation@NonNull public DingiMapOptions setPrefetchesTiles(boolean enable)
enable
- true to enable@NonNull public DingiMapOptions 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 disable@NonNull public DingiMapOptions localIdeographFontFamily(java.lang.String fontFamily)
The font family argument is passed to Typeface.create(String, int)
.
Default system fonts are defined in '/system/etc/fonts.xml'
fontFamily
- font family for local ideograph generation.@NonNull public DingiMapOptions 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 android.graphics.drawable.Drawable getCompassImage()
public boolean getLogoEnabled()
public int getLogoGravity()
public int[] getLogoMargins()
public java.lang.String getStyleUrl()
public java.lang.String getStyleJson()
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()
describeContents
in interface android.os.Parcelable
public void writeToParcel(@NonNull android.os.Parcel dest, int flags)
writeToParcel
in interface android.os.Parcelable
public boolean equals(@Nullable java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object