mapbox-maps-android/com.mapbox.maps.plugin.indoorselector/IndoorSelectorPlugin

IndoorSelectorPlugin

interface IndoorSelectorPlugin : ViewPlugin, LifecyclePlugin, IndoorSelectorSettingsInterface

Plugin interface for indoor floor selector. Displays a vertical list of floors with navigation controls.

The plugin automatically subscribes to IndoorManager events and updates the UI when floor data is available. The UI is automatically shown/hidden based on indoor data availability.

Example usage:

// Configure the plugin (optional - defaults are provided)
mapView.indoorSelector.updateSettings {
  enabled = true
}

Functions

addOnFloorSelectedListener

abstract fun addOnFloorSelectedListener(listener: OnFloorSelectedListener)

Add a floor selection listener to be notified when user selects a floor.

bind

abstract fun bind(mapView: FrameLayout, attrs: AttributeSet?, pixelRatio: Float): View

Bind a view instance

cleanup

open fun cleanup()

Called when the map is destroyed. Should be used to cleanup plugin resources for that map.

getSettings

abstract fun getSettings(): IndoorSelectorSettings

Get current indoorselector configuration.

initialize

open fun initialize()

Called when the plugin is first added to the map.

onDelegateProvider

open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

onFloorSelected

@RestrictTo(value = [RestrictTo.Scope.LIBRARY])

abstract fun onFloorSelected(floorId: String)

Called when a floor is selected by the user.

onPluginView

open fun onPluginView(view: View)

Provides a view instances returned in inflate after it's been added to the MapView.

onStart

open fun onStart()

Called whenever activity's/fragment's lifecycle is entering a "started" state.

onStop

open fun onStop()

Called whenever activity's/fragment's lifecycle is entering a "stopped" state.

removeOnFloorSelectedListener

abstract fun removeOnFloorSelectedListener(listener: OnFloorSelectedListener)

Remove a previously added floor selection listener.

updateFloors

@RestrictTo(value = [RestrictTo.Scope.LIBRARY])

abstract fun updateFloors(floors: List<IndoorFloor>, selectedFloorId: String?)

Update the list of available floors and the currently selected floor.

updateSettings

abstract fun updateSettings(block: IndoorSelectorSettings.Builder.() -> Unit)

Update indoorselector configuration, the update will be applied to the plugin automatically.

Properties

enabled

abstract var enabled: Boolean

Whether the indoor selector is visible on the map. Default value: true.

marginBottom

abstract var marginBottom: Float

Defines the margin to the bottom that the indoor selector honors. Default value: 8.

marginLeft

abstract var marginLeft: Float

Defines the margin to the left that the indoor selector honors. Default value: 8.

marginRight

abstract var marginRight: Float

Defines the margin to the right that the indoor selector honors. Default value: 8.

marginTop

abstract var marginTop: Float

Defines the margin to the top that the indoor selector honors. Default value: 60.

position

abstract var position: Int

Defines where the indoor selector is positioned on the map. Default value: "top-right".