MapLibre Native Android/org.maplibre.android.maps/MapLibreMapOptions

MapLibreMapOptions

open class MapLibreMapOptions : Parcelable

Defines configuration MapLibreMapOptions for a MapLibreMap. 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(MapLibreMapOptions). If you are using a MapView, you can pass these options in using the constructor MapView(Context, MapLibreMapOptions). If you add a map using XML, then you can apply these options using custom XML tags.

Constructors

MapLibreMapOptions

constructor()

Creates a new MapLibreMapOptions object.

Properties

actionJournalEnabled

open val actionJournalEnabled: Boolean

actionJournalLogFileCount

open val actionJournalLogFileCount: Long

actionJournalLogFileSize

open val actionJournalLogFileSize: Long

actionJournalPath

open val actionJournalPath: String

actionJournalRenderingReportInterval

open val actionJournalRenderingReportInterval: Int

open val apiBaseUri: String

attributionEnabled

open val attributionEnabled: Boolean

attributionGravity

open val attributionGravity: Int

attributionMargins

open val attributionMargins: Array<Int>

attributionTintColor

open val attributionTintColor: Int

open val compassEnabled: Boolean

open val compassGravity: Int

open val compassImage: Drawable

open val compassMargins: Array<Int>

CONTENTS_FILE_DESCRIPTOR

val CONTENTS_FILE_DESCRIPTOR: Int = 1

val CREATOR: Parcelable.Creator<MapLibreMapOptions>

crossSourceCollisions

open val crossSourceCollisions: Boolean

open val debugActive: Boolean

doubleTapGesturesEnabled

open val doubleTapGesturesEnabled: Boolean

foregroundLoadColor

open val foregroundLoadColor: Int

horizontalScrollGesturesEnabled

open val horizontalScrollGesturesEnabled: Boolean

localIdeographFontFamily

open val localIdeographFontFamily: String

open val logoEnabled: Boolean

open val logoGravity: Int

open val logoMargins: Array<Int>

PARCELABLE_WRITE_RETURN_VALUE

val PARCELABLE_WRITE_RETURN_VALUE: Int = 1

open val pixelRatio: Float

prefetchesTiles

open var prefetchesTiles: Boolean

prefetchZoomDelta

@get:IntRange(from = 0)

open var prefetchZoomDelta: Int

quickZoomGesturesEnabled

open val quickZoomGesturesEnabled: Boolean

rotateGesturesEnabled

open val rotateGesturesEnabled: Boolean

scrollGesturesEnabled

open val scrollGesturesEnabled: Boolean

open val textureMode: Boolean

tiltGesturesEnabled

open val tiltGesturesEnabled: Boolean

translucentTextureSurface

open val translucentTextureSurface: Boolean

zoomGesturesEnabled

open val zoomGesturesEnabled: Boolean

Functions

actionJournalEnabled

open fun actionJournalEnabled(actionJournalEnabled: Boolean): MapLibreMapOptions

Enable action journal event logging, defaults to false.

actionJournalLogFileCount

open fun actionJournalLogFileCount(actionJournalLogFileCount: Long): MapLibreMapOptions

Set the action journal log file count.

actionJournalLogFileSize

open fun actionJournalLogFileSize(actionJournalLogFileSize: Long): MapLibreMapOptions

Set the action journal log file size.

actionJournalPath

open fun actionJournalPath(@NonNull actionJournalPath: String): MapLibreMapOptions

Set the action journal log path.

actionJournalRenderingReportInterval

open fun actionJournalRenderingReportInterval(actionJournalRenderingReportInterval: Int): MapLibreMapOptions

Set the number of seconds to wait between rendering stats reports.

open fun apiBaseUri(apiBaseUri: String): MapLibreMapOptions

Specifies the URI used for API endpoint.

open fun ~~apiBaseUrl~~(apiBaseUrl: String): MapLibreMapOptions

Specifies the URL used for API endpoint.

attributionEnabled

open fun attributionEnabled(enabled: Boolean): MapLibreMapOptions

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

attributionGravity

open fun attributionGravity(gravity: Int): MapLibreMapOptions

Specifies the gravity state of attribution for a map view.

attributionMargins

open fun attributionMargins(margins: Array<Int>): MapLibreMapOptions

Specifies the margin state of attribution for a map view

attributionTintColor

open fun attributionTintColor(@ColorInt color: Int): MapLibreMapOptions

Specifies the tint color of the attribution for a map view

open fun camera(cameraPosition: CameraPosition): MapLibreMapOptions

Specifies a the initial camera position for the map view.

open fun compassEnabled(enabled: Boolean): MapLibreMapOptions

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

compassFadesWhenFacingNorth

open fun compassFadesWhenFacingNorth(compassFadeWhenFacingNorth: Boolean): MapLibreMapOptions

Specifies if the maplibre_compass_icon fades to invisible when facing north.

open fun compassGravity(gravity: Int): MapLibreMapOptions

Specifies the gravity state of maplibre_compass_icon for a map view.

open fun compassImage(compass: Drawable): MapLibreMapOptions

Specifies the image of the CompassView.

open fun compassMargins(margins: Array<Int>): MapLibreMapOptions

Specifies the margin state of maplibre_compass_icon for a map view

createFromAttributes

open fun createFromAttributes(@NonNull context: Context): MapLibreMapOptions

Creates a default MapLibreMapsOptions from a given context.

open fun createFromAttributes(@NonNull context: Context, @Nullable attrs: AttributeSet): MapLibreMapOptions

Creates a MapLibreMapsOptions from the attribute set.

crossSourceCollisions

open fun crossSourceCollisions(crossSourceCollisions: Boolean): MapLibreMapOptions

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

open fun debugActive(enabled: Boolean): MapLibreMapOptions

Specifies the used debug type for a map view.

describeContents

open fun describeContents(): Int

doubleTapGesturesEnabled

open fun doubleTapGesturesEnabled(enabled: Boolean): MapLibreMapOptions

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

open fun equals(@Nullable o: Any): Boolean

foregroundLoadColor

open fun foregroundLoadColor(@ColorInt loadColor: Int): MapLibreMapOptions

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

open fun ~~getApiBaseUrl~~(): String

Get the current configured API endpoint base URL.

open fun getCamera(): CameraPosition

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

getCompassFadeFacingNorth

open fun getCompassFadeFacingNorth(): Boolean

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

getMaxPitchPreference

open fun getMaxPitchPreference(): Double

Get the current configured maximum pitch for a map view.

getMaxZoomPreference

open fun getMaxZoomPreference(): Double

Get the current configured maximum zoom for a map view.

getMinPitchPreference

open fun getMinPitchPreference(): Double

Get the current configured min pitch for a map view.

getMinZoomPreference

open fun getMinZoomPreference(): Double

Get the current configured min zoom for a map view.

getRenderSurfaceOnTop

open fun getRenderSurfaceOnTop(): Boolean

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

open fun hashCode(): Int

horizontalScrollGesturesEnabled

open fun horizontalScrollGesturesEnabled(enabled: Boolean): MapLibreMapOptions

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

isLocalIdeographFontFamilyEnabled

open fun isLocalIdeographFontFamilyEnabled(): Boolean

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

localIdeographFontFamily

open fun localIdeographFontFamily(fontFamily: String): MapLibreMapOptions

Set the font family for generating glyphs locally for ideographs in the 'CJK Unified Ideographs' and 'Hangul Syllables' ranges.

open fun localIdeographFontFamily(fontFamilies: Array<String>): MapLibreMapOptions

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

localIdeographFontFamilyEnabled

open fun localIdeographFontFamilyEnabled(enabled: Boolean): MapLibreMapOptions

Enable local ideograph font family, defaults to true.

open fun logoEnabled(enabled: Boolean): MapLibreMapOptions

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

open fun logoGravity(gravity: Int): MapLibreMapOptions

Specifies the gravity state of logo for a map view.

open fun logoMargins(margins: Array<Int>): MapLibreMapOptions

Specifies the margin state of logo for a map view

maxPitchPreference

open fun maxPitchPreference(maxPitch: Double): MapLibreMapOptions

Specifies the used maximum pitch for a map view.

maxZoomPreference

open fun maxZoomPreference(maxZoom: Double): MapLibreMapOptions

Specifies the used maximum zoom level for a map view.

minPitchPreference

open fun minPitchPreference(minPitch: Double): MapLibreMapOptions

Specifies the used minimum pitch for a map view.

minZoomPreference

open fun minZoomPreference(minZoom: Double): MapLibreMapOptions

Specifies the used minimum zoom level for a map view.

open fun pixelRatio(pixelRatio: Float): MapLibreMapOptions

Set the custom pixel ratio configuration to override the default value from resources.

quickZoomGesturesEnabled

open fun quickZoomGesturesEnabled(enabled: Boolean): MapLibreMapOptions

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

renderSurfaceOnTop

open fun renderSurfaceOnTop(renderOnTop: Boolean)

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

rotateGesturesEnabled

open fun rotateGesturesEnabled(enabled: Boolean): MapLibreMapOptions

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

scrollGesturesEnabled

open fun scrollGesturesEnabled(enabled: Boolean): MapLibreMapOptions

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

open fun textureMode(textureMode: Boolean): MapLibreMapOptions

Enable android.view.TextureView as rendered surface.

tiltGesturesEnabled

open fun tiltGesturesEnabled(enabled: Boolean): MapLibreMapOptions

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

translucentTextureSurface

open fun translucentTextureSurface(translucentTextureSurface: Boolean): MapLibreMapOptions

open fun writeToParcel(@NonNull dest: Parcel, flags: Int)

zoomGesturesEnabled

open fun zoomGesturesEnabled(enabled: Boolean): MapLibreMapOptions

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