Mapbox Maps Android/com.mapbox.maps/MapInitOptions

MapInitOptions

Defines configuration MapInitOptions 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.

data class MapInitOptions(context: Context, resourceOptions: ResourceOptions, mapOptions: MapOptions, plugins: List<Plugin>, cameraOptions: CameraOptions?, textureView: Boolean, styleUri: String?, attrs: AttributeSet?)

Constructors

MapInitOptions

fun MapInitOptions(context: Context, resourceOptions: ResourceOptions, mapOptions: MapOptions, plugins: List<Plugin>, cameraOptions: CameraOptions?, textureView: Boolean, styleUri: String?, attrs: AttributeSet?)

Types

Companion

Static methods

object Companion

Functions

component1

operator fun component1(): Context

component2

operator fun component2(): ResourceOptions

component3

operator fun component3(): MapOptions

component4

operator fun component4(): List<Plugin>

component5

operator fun component5(): CameraOptions?

component6

operator fun component6(): Boolean

component7

operator fun component7(): String?

component8

operator fun component8(): AttributeSet?

copy

fun copy(context: Context, resourceOptions: ResourceOptions, mapOptions: MapOptions, plugins: List<Plugin>, cameraOptions: CameraOptions?, textureView: Boolean, styleUri: String?, attrs: AttributeSet?): MapInitOptions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

Properties

attrs

The AttributeSet object that init the MapView.

var attrs: AttributeSet?

cameraOptions

The Initial Camera options when creating a MapView.

var cameraOptions: CameraOptions?

context

The context of the MapView.

val context: Context

mapOptions

Describes the map options value when using a MapView.

var mapOptions: MapOptions

plugins

The plugins, a list of strings representing class names, that will be loaded as part of MapView initialisation,

var plugins: List<Plugin>

resourceOptions

Resource options when using a MapView. Access token required when using a Mapbox service. Please see https://www.mapbox.com/help/create-api-access-token/ to learn how to create one.More information in this guide https://www.mapbox.com/help/first-steps-android-sdk/#access-tokens.

var resourceOptions: ResourceOptions

styleUri

The styleUri will applied for the MapView in the onStart lifecycle event if no style is set. Default is Style.MAPBOX_STREETS. If set to null, then there is no default style will be loaded.

val styleUri: String?

textureView

Flag indicating to use a TextureView as render surface for the MapView. Default is false.

var textureView: Boolean