Mappedin Android SDK/com.mappedin.sdk/MPIMapViewInterface

MPIMapViewInterface

interface MPIMapViewInterface

This class contains methods that help to display and interact with a Mappedin venue

Functions

addInteractivePolygon

abstract fun addInteractivePolygon(polygon: MPINavigatable.MPIPolygon)

abstract fun addInteractivePolygon(polygonId: String)

Adds an interactive polygon (allows it to be clickable)

changeLanguage

abstract fun changeLanguage(languageCode: String, cache: Boolean = false)

Changes the language of the venue. This will trigger a re-fetch of the venue data.

clearAllPolygonColors

abstract suspend fun clearAllPolygonColors()

abstract fun clearAllPolygonColors(completionCallback: (MPIError?) -> Unit?)

Clears color on all polygons

createCustomTooltip

abstract fun createCustomTooltip( coordinate: MPIMap.MPICoordinate, contentHtml: String, selector: String, tooltipOptions: MPIOptions.Tooltip = MPIOptions.Tooltip(), callback: (id: String?) -> Unit? = null)

abstract fun createCustomTooltip( node: MPINavigatable.MPINode, contentHtml: String, selector: String, tooltipOptions: MPIOptions.Tooltip = MPIOptions.Tooltip(), callback: (id: String?) -> Unit? = null)

createMarker

abstract fun createMarker( coordinate: MPIMap.MPICoordinate, contentHtml: String, markerOptions: MPIOptions.Marker = MPIOptions.Marker()): String

Creates a marker on a MPINavigatable.MPICoordinate

abstract fun createMarker( node: MPINavigatable.MPINode, contentHtml: String, markerOptions: MPIOptions.Marker = MPIOptions.Marker()): String

createTooltip

abstract fun createTooltip( coordinate: MPIMap.MPICoordinate, contentHtml: String, tooltipOptions: MPIOptions.Tooltip = MPIOptions.Tooltip(), callback: (id: String?) -> Unit? = null)

abstract fun createTooltip( node: MPINavigatable.MPINode, contentHtml: String, tooltipOptions: MPIOptions.Tooltip = MPIOptions.Tooltip(), callback: (id: String?) -> Unit? = null)

drawPath

~~abstract~~ ~~fun~~ ~~drawPath~~(path: List<MPINavigatable.MPINode>, pathOptions: MPIOptions.Path? = null)

Draws a path on the MPIMapView Deprecated: Use MPIPathManager.addPath instead.

enableImageFlippingForPolygon

abstract fun enableImageFlippingForPolygon(polygon: MPINavigatable.MPIPolygon)

Enables image flipping for a polygon

getCurrentLanguage

abstract suspend fun getCurrentLanguage(): MPILanguage

abstract fun getCurrentLanguage(languageCallback: (MPILanguage?) -> Unit)

Returns the current language of the venue.

getDirections

abstract suspend fun getDirections( to: MPIDestinationSet, from: MPINavigatable, accessible: Boolean = false): List<MPIDirections>

abstract fun getDirections( to: MPIDestinationSet, from: MPINavigatable, accessible: Boolean = false, directionsCallback: (List<MPIDirections>?) -> Unit)

Get directions to a MPIDestinationSet (MPINavigatable.MPINode, MPINavigatable.MPILocation, MPINavigatable.MPIPolygon) from another MPINavigatable

abstract suspend fun getDirections( to: MPINavigatable, from: MPINavigatable, accessible: Boolean = false): MPIDirections

abstract fun getDirections( to: MPINavigatable, from: MPINavigatable, accessible: Boolean = false, directionsCallback: (MPIDirections?) -> Unit)

Get directions to a MPINavigatable (MPINavigatable.MPINode, MPINavigatable.MPILocation, MPINavigatable.MPIPolygon) from another MPINavigatable

getDistance

abstract suspend fun getDistance( to: MPINavigatable, from: MPINavigatable, accessible: Boolean = false): Float

abstract fun getDistance( to: MPINavigatable, from: MPINavigatable, accessible: Boolean = false, distanceCallback: (Float?) -> Unit)

Get the distance in meters between a MPINavigatable (MPINavigatable.MPINode, MPINavigatable.MPILocation, MPINavigatable.MPIPolygon) and MPINavigatable

getNearestNodeByScreenCoordinates

abstract suspend fun getNearestNodeByScreenCoordinates( x: Int, y: Int, map: MPIMap? = null): MPINavigatable.MPINode

abstract fun getNearestNodeByScreenCoordinates( x: Int, y: Int, map: MPIMap? = null, nearestNodeCallback: (MPINavigatable.MPINode?) -> Unit)

Gets the nearest node by screen coordinates

getPolygonsAtCoordinate

abstract fun getPolygonsAtCoordinate( coord: MPIMap.MPICoordinate, options: MPIOptions.GetPolygonsAtCoordinate? = null, polygonsCallback: (List<MPINavigatable.MPIPolygon>?) -> Unit)

Gets a list of polygons by map coordinates

getPolygonsAtScreenCoordinate

abstract fun getPolygonsAtScreenCoordinate( x: Int, y: Int, options: MPIOptions.GetPolygonsAtCoordinate? = null, polygonsCallback: (List<MPINavigatable.MPIPolygon>?) -> Unit)

Gets a list of polygons by screen coordinates

labelAllLocations

abstract fun labelAllLocations(options: MPIOptions.FlatLabelAllLocations? = null)

abstract fun labelAllLocations(options: MPIOptions.FloatingLabelAllLocations? = null)

Label all polygons with locations either loaded via the API or passed in

labelPolygon

abstract fun labelPolygon(polygon: MPINavigatable.MPIPolygon, options: MPIOptions.FlatLabel)

abstract fun labelPolygon(polygonId: String, options: MPIOptions.FlatLabel)

Sets a flat label for MPINavigatable.MPIPolygon

abstract fun labelPolygon(polygon: MPINavigatable.MPIPolygon, options: MPIOptions.FloatingLabel)

abstract fun labelPolygon(polygonId: String, options: MPIOptions.FloatingLabel)

Sets a floating label for MPINavigatable.MPIPolygon

loadVenue

abstract fun loadVenue( options: MPIOptions.Init, showVenueOptions: MPIOptions.ShowVenue? = null, errorCallback: (MPIError?) -> Unit?)

Loads the venue based on the options passed in MPIMapView

removeAllPaths

~~abstract~~ ~~suspend~~ ~~fun~~ ~~removeAllPaths~~()

~~abstract~~ ~~fun~~ ~~removeAllPaths~~(completionCallback: (MPIError?) -> Unit?)

Remove all paths on the MPIMapView Deprecated: Use MPIPathManager.removeAllPaths instead.")

removeMarker

abstract fun removeMarker(markerId: String)

Removes a marker from a MPINavigatable.MPINode

removeTooltip

abstract fun removeTooltip(id: String)

setAmbientOcclusionConfiguration

abstract fun setAmbientOcclusionConfiguration(ambientOcclusionConfiguration: MPIOptions.AmbientOcclusionConfiguration)

Sets the ambient occlusion configuration.

setAntialiasConfiguration

abstract fun setAntialiasConfiguration(antialiasConfiguration: MPIOptions.AntialiasConfiguration)

Sets the anti aliasing configuration.

setMap

abstract suspend fun setMap(map: MPIMap)

abstract suspend fun setMap(mapId: String)

abstract fun setMap(map: MPIMap, completionCallback: (MPIError?) -> Unit?)

abstract fun setMap(mapId: String, completionCallback: (MPIError?) -> Unit?)

Sets the MPIMap of the MPIMapView

setPolygonColor

abstract fun setPolygonColor(polygon: MPINavigatable.MPIPolygon, color: String)

Sets the color of the MPINavigatable.MPIPolygon

showVenue

abstract fun showVenue( venueResponse: MPIVenueResponse, showVenueOptions: MPIOptions.ShowVenue? = null, errorCallback: (MPIError?) -> Unit?)

abstract fun showVenue( venueResponse: String, showVenueOptions: MPIOptions.ShowVenue? = null, errorCallback: (MPIError?) -> Unit?)

Shows the venue based on the venue data and options passed in MPIMapView

Inheritors

MPIMapView