Mappedin Android SDK/com.mappedin.sdk/MPIMapViewInterface

MPIMapViewInterface

interface MPIMapViewInterface
Content copied to clipboard

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

Functions

Link copied to clipboard
abstract fun addInteractivePolygon(polygon: MPINavigatable.MPIPolygon)
Content copied to clipboard
abstract fun addInteractivePolygon(polygonId: String)
Content copied to clipboard

Adds an interactive polygon (allows it to be clickable)

Link copied to clipboard
abstract fun changeLanguage(languageCode: String, cache: Boolean = false)
Content copied to clipboard

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

Link copied to clipboard
abstract suspend fun clearAllPolygonColors()
Content copied to clipboard
abstract fun clearAllPolygonColors(completionCallback: (MPIError?) -> Unit?)
Content copied to clipboard

Clears color on all polygons

Link copied to clipboard
abstract fun createCustomTooltip(    coordinate: MPIMap.MPICoordinate,     contentHtml: String,     selector: String,     tooltipOptions: MPIOptions.Tooltip = MPIOptions.Tooltip(),     callback: (id: String?) -> Unit? = null)
Content copied to clipboard
abstract fun createCustomTooltip(    node: MPINavigatable.MPINode,     contentHtml: String,     selector: String,     tooltipOptions: MPIOptions.Tooltip = MPIOptions.Tooltip(),     callback: (id: String?) -> Unit? = null)
Content copied to clipboard
Link copied to clipboard
abstract fun createMarker(    coordinate: MPIMap.MPICoordinate,     contentHtml: String,     markerOptions: MPIOptions.Marker = MPIOptions.Marker()): String
Content copied to clipboard

Creates a marker on a MPINavigatable.MPICoordinate Deprecated: Use MPIMarkerManager.add instead.

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

Creates a marker on a MPINavigatable.MPINode Deprecated: Use MPIMarkerManager.add instead.

Link copied to clipboard
abstract fun createTooltip(    coordinate: MPIMap.MPICoordinate,     contentHtml: String,     tooltipOptions: MPIOptions.Tooltip = MPIOptions.Tooltip(),     callback: (id: String?) -> Unit? = null)
Content copied to clipboard
abstract fun createTooltip(    node: MPINavigatable.MPINode,     contentHtml: String,     tooltipOptions: MPIOptions.Tooltip = MPIOptions.Tooltip(),     callback: (id: String?) -> Unit? = null)
Content copied to clipboard
Link copied to clipboard
abstract fun drawPath(path: List<MPINavigatable.MPINode>, pathOptions: MPIOptions.Path? = null)
Content copied to clipboard

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

Link copied to clipboard
abstract fun enableImageFlippingForPolygon(polygon: MPINavigatable.MPIPolygon)
Content copied to clipboard

Enables image flipping for a polygon

Link copied to clipboard
abstract suspend fun getCurrentLanguage(): MPILanguage
Content copied to clipboard
abstract fun getCurrentLanguage(languageCallback: (MPILanguage?) -> Unit)
Content copied to clipboard

Returns the current language of the venue.

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

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
Content copied to clipboard
abstract fun getDirections(    to: MPINavigatable,     from: MPINavigatable,     accessible: Boolean = false,     directionsCallback: (MPIDirections?) -> Unit)
Content copied to clipboard

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

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

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

Link copied to clipboard
abstract fun getMappedinCoordinateAtScreenCoordinate(    x: Int,     y: Int,     map: MPIMap,     callback: (MPIMap.MPICoordinate?) -> Unit)
Content copied to clipboard

Get the MPIMap.MPICoordinate using a MapView's screen x and y coordinate. The coordinate is relative to the top left corner of the map view. The top left corner of the MapView is (0, 0). The bottom right corner is MapView.width and MapView.height.

Link copied to clipboard
abstract suspend fun getNearestNodeByScreenCoordinates(    x: Int,     y: Int,     map: MPIMap? = null): MPINavigatable.MPINode
Content copied to clipboard
abstract fun getNearestNodeByScreenCoordinates(    x: Int,     y: Int,     map: MPIMap? = null,     nearestNodeCallback: (MPINavigatable.MPINode?) -> Unit)
Content copied to clipboard

Gets the nearest node by screen coordinates

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

Gets a list of polygons by map coordinates

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

Gets a list of polygons by screen coordinates

Link copied to clipboard
abstract fun labelAllLocations(options: MPIOptions.FlatLabelAllLocations? = null)
Content copied to clipboard
abstract fun labelAllLocations(options: MPIOptions.FloatingLabelAllLocations? = null)
Content copied to clipboard

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

Link copied to clipboard
abstract fun labelPolygon(polygon: MPINavigatable.MPIPolygon, options: MPIOptions.FlatLabel)
Content copied to clipboard
abstract fun labelPolygon(polygonId: String, options: MPIOptions.FlatLabel)
Content copied to clipboard

Sets a flat label for MPINavigatable.MPIPolygon

abstract fun labelPolygon(polygon: MPINavigatable.MPIPolygon, options: MPIOptions.FloatingLabel)
Content copied to clipboard
abstract fun labelPolygon(polygonId: String, options: MPIOptions.FloatingLabel)
Content copied to clipboard

Sets a floating label for MPINavigatable.MPIPolygon

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

Loads the venue based on the options passed in MPIMapView

Link copied to clipboard
abstract suspend fun removeAllPaths()
Content copied to clipboard
abstract fun removeAllPaths(completionCallback: (MPIError?) -> Unit?)
Content copied to clipboard

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

Link copied to clipboard
abstract fun removeMarker(markerId: String)
Content copied to clipboard

Removes a marker from a MPINavigatable.MPINode Deprecated: Use MPIMarkerManager.remove instead.

Link copied to clipboard
abstract fun removeTooltip(id: String)
Content copied to clipboard
Link copied to clipboard
abstract fun setAmbientOcclusionConfiguration(ambientOcclusionConfiguration: MPIOptions.AmbientOcclusionConfiguration)
Content copied to clipboard

Sets the ambient occlusion configuration.

Link copied to clipboard
abstract fun setAntialiasConfiguration(antialiasConfiguration: MPIOptions.AntialiasConfiguration)
Content copied to clipboard

Sets the anti aliasing configuration.

Link copied to clipboard
abstract suspend fun setMap(map: MPIMap)
Content copied to clipboard
abstract suspend fun setMap(mapId: String)
Content copied to clipboard
abstract fun setMap(map: MPIMap, completionCallback: (MPIError?) -> Unit?)
Content copied to clipboard
abstract fun setMap(mapId: String, completionCallback: (MPIError?) -> Unit?)
Content copied to clipboard

Sets the MPIMap of the MPIMapView

Link copied to clipboard
abstract fun setPolygonColor(polygon: MPINavigatable.MPIPolygon, color: String)
Content copied to clipboard

Sets the color of the MPINavigatable.MPIPolygon

Link copied to clipboard
abstract fun showVenue(    venueResponse: MPIVenueResponse,     showVenueOptions: MPIOptions.ShowVenue? = null,     errorCallback: (MPIError?) -> Unit?)
Content copied to clipboard
abstract fun showVenue(    venueResponse: String,     showVenueOptions: MPIOptions.ShowVenue? = null,     errorCallback: (MPIError?) -> Unit?)
Content copied to clipboard

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

Inheritors

Link copied to clipboard