com.tomtom.sdk.maps:map-display-common/com.tomtom.sdk.map.display/MapOptions

MapOptions

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class MapOptions constructor(val mapKey: String, val cameraOptions: CameraOptions? = null, val padding: Padding = Padding(), val mapStyle: StyleDescriptor? = null, val styleMode: StyleMode = StyleMode.MAIN, val onlineCachePolicy: OnlineCachePolicy = OnlineCachePolicy.Default, val renderToTexture: Boolean = false) : Parcelable

The MapOptions class configures initial behavior and visual style of the map. It enables setting the default zoom level, the map language, style and more. The MapOptions is used as an argument for MapFragment.newInstance, which instantiates MapFragment object.

val mapOptions = MapOptions(mapKey = "YOUR_TOMTOM_API_KEY")
val mapFragment = MapFragment.newInstance(mapOptions)
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(mapKey: String, initialCameraOptions: InitialCameraOptions, padding: Padding = Padding(), mapStyle: StyleDescriptor? = null, styleMode: StyleMode = StyleMode.MAIN, onlineCachePolicy: OnlineCachePolicy = OnlineCachePolicy.Default, renderToTexture: Boolean = false)

The MapOptions class configures initial behavior and visual style of the map. It enables setting the default zoom level, the map language, style and more. The MapOptions is used as an argument for MapFragment.newInstance, which instantiates MapFragment object.

constructor(mapKey: String, cameraOptions: CameraOptions? = null, padding: Padding = Padding(), mapStyle: StyleDescriptor? = null, styleMode: StyleMode = StyleMode.MAIN, onlineCachePolicy: OnlineCachePolicy = OnlineCachePolicy.Default, renderToTexture: Boolean = false)

Types

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
object Companion

Properties

Link copied to clipboard
val cameraOptions: CameraOptions? = null

Provides CameraOptions associated with the current MapOptions.

Link copied to clipboard
val mapKey: String

Provides Maps API key.

Link copied to clipboard
val mapStyle: StyleDescriptor? = null

Provides custom StyleDescriptor with style that will be used as initial style.

Link copied to clipboard
val onlineCachePolicy: OnlineCachePolicy

Defines OnlineCachePolicy that will be used for the HTTP caching.

Link copied to clipboard
val padding: Padding

Provides Padding of the map view. By default, padding is set to 0 for all sides.

Link copied to clipboard
val renderToTexture: Boolean = false

If set to true render to texture view rather than surface view.

Link copied to clipboard
val styleMode: StyleMode

Defines StyleMode that will be used during the initialization.

Functions

Link copied to clipboard
operator fun component1(): String
Link copied to clipboard
operator fun component2(): CameraOptions?
Link copied to clipboard
operator fun component3(): Padding
Link copied to clipboard
operator fun component4(): StyleDescriptor?
Link copied to clipboard
operator fun component5(): StyleMode
Link copied to clipboard
operator fun component6(): OnlineCachePolicy
Link copied to clipboard
operator fun component7(): Boolean
Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun copy(mapKey: String = this.mapKey, cameraOptions: CameraOptions? = this.cameraOptions, padding: Padding = this.padding, mapStyle: StyleDescriptor? = this.mapStyle, styleMode: StyleMode = this.styleMode, onlineCachePolicy: OnlineCachePolicy = this.onlineCachePolicy, renderToTexture: Boolean = this.renderToTexture): MapOptions
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String

Inherited functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)