MapControl

java.lang.Object
- com.mapsindoors.mapssdk.MapControl

public final class MapControl
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MapControl.FloorTileSize
Deprecated.

static interface MapControl.TileCacheScheme
Deprecated.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MapControl.FloorTileSize` Deprecated.
`static interface`	`MapControl.TileCacheScheme` Deprecated.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`TILE_CACHESCHEME_NONE` Deprecated.
`static int`	`TILE_CACHESCHEME_OFFLINE` Deprecated.
`static int`	`TILE_CACHESCHEME_PERSISTENT` Deprecated.
`static int`	`TILE_CACHESCHEME_TEMPORARY` Deprecated.
`static int`	`TILE_SIZE_X1` Deprecated.
`static int`	`TILE_SIZE_X2` Deprecated.

Constructor Summary

Constructors
Constructor and Description

MapControl(android.content.Context context)
Creates a MapControl instance without having a Google Map object available

Constructors
Constructor and Description
`MapControl(android.content.Context context)` Creates a MapControl instance without having a Google Map object available

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDisplayRule(LocationDisplayRule locationDisplayRule)` Adds a custom display rule
`void`	`addDisplayRule(LocationDisplayRule locationDisplayRule, OnResultReadyListener onResultReadyListener)` Adds a new display rule
`void`	`addDisplayRules(java.util.List<LocationDisplayRule> displayRuleList)` Adds a new set of custom display rules
`void`	`addDisplayRules(java.util.List<LocationDisplayRule> displayRuleList, OnResultReadyListener onResultReadyListener)` Add rules needed to display locations correctly.
`void`	`addOnCameraIdleListener(com.google.android.gms.maps.GoogleMap.OnCameraIdleListener onCameraIdleListener)` Adds a callback that's invoked when camera movement has ended.
`void`	`addOnCameraMoveCanceledListener(com.google.android.gms.maps.GoogleMap.OnCameraMoveCanceledListener onCameraMoveCanceledListener)` Adds a callback that's invoked when camera motion is stopped or interrupted by a new type of animation.
`void`	`addOnCameraMoveListener(com.google.android.gms.maps.GoogleMap.OnCameraMoveListener onCameraMoveListener)` Adds a callback that's invoked repeatedly while the camera is in motion.
`void`	`addOnCameraMoveStartedListener(com.google.android.gms.maps.GoogleMap.OnCameraMoveStartedListener onCameraMoveStartedListener)` Adds a callback that's invoked when the camera starts moving or the reason for camera motion has changed.
`void`	`bindToMap(com.google.android.gms.maps.GoogleMap googleMap, android.view.View view)` Deprecated.
`void`	`clearMap()` Invoke this method to restore the map to its default state (POIs shown based on their display rules, etc.)
`void`	`deSelectLocation()` Call this to deselect a location previously selected with `selectLocation(MPLocation)`
`void`	`disableLiveData(java.lang.String domainType)` Disables live data on a specific domainType
`boolean`	`displaySearchResults(java.util.List<MPLocation> locations)` Use this method to display temporary locations, not points of interests location.
`boolean`	`displaySearchResults(java.util.List<MPLocation> locations, boolean animateCamera)` Use this method to display temporary locations, not points of interests location.
`boolean`	`displaySearchResults(java.util.List<MPLocation> locations, boolean animateCamera, int cameraPadding)` Use this method to display temporary locations, not points of interests location.
`boolean`	`displaySearchResults(java.util.List<MPLocation> locations, boolean animateCamera, int cameraPadding, boolean showInfoWindow)` Use this method to display temporary locations, not points of interests location.
`boolean`	`displaySearchResults(java.util.List<MPLocation> locations, boolean animateCamera, int cameraPadding, boolean showInfoWindow, com.google.android.gms.maps.CameraUpdate googleMapCameraUpdate, int durationMs, com.google.android.gms.maps.GoogleMap.CancelableCallback googleMapCancelableCallback)` Use this method to display temporary locations, not points of interests location.
`boolean`	`displaySearchResults(java.util.List<MPLocation> locations, boolean animateCamera, int cameraPadding, boolean showInfoWindow, com.google.android.gms.maps.CameraUpdate googleMapCameraUpdate, int durationMs, com.google.android.gms.maps.GoogleMap.CancelableCallback googleMapCancelableCallback, ReadyListener readyListener)` Use this method to display temporary locations, not points of interests location.
`boolean`	`displaySearchResults(java.util.List<MPLocation> locations, boolean animateCamera, int cameraPadding, ReadyListener readyListener)` Use this method to display temporary locations, not points of interests location.
`boolean`	`displaySearchResults(java.util.List<MPLocation> locations, ReadyListener readyListener)` Use this method to display temporary locations, not points of interests location.
`void`	`enableClickedPOIHighlight(boolean enable)` Enables/disables POI area highlighting
`void`	`enableFloorSelector(boolean enable)` Enables or disables the `FloorSelectorInterface`, i.e.
`void`	`enableLiveData(java.lang.String domainType)` Enables live data on a specific domain and uses MapsIndoors standard graphic implementation
`void`	`enableLiveData(java.lang.String domainType, OnLiveLocationUpdateListener onLiveLocationUpdateListener)` Enables live data on a specific domain
`int`	`getClickedPOIHighlightFillColor()` Get the selected area's fill color
`int`	`getClickedPOIHighlightOutlineStrokeColor()` Get the selected area's stroke color
`float`	`getClickedPOIHighlightOutlineStrokeWidth()` Get the selected area's stroke width
`float`	`getClickedPOIHighlightShowingZoomLevel()` Get the zoom level a selected area will start showing
`Building`	`getCurrentBuilding()` Returns the current visible `Building` (the one having the viewport's center/target within its bounding box or closest to any of its contour)
`Floor`	`getCurrentBuildingFloor()` Returns the current `Floor` of the current `Building` in focus
`int`	`getCurrentFloorIndex()` Returns the current selected floor index
`PositionResult`	`getCurrentPosition()` Get the current user position (blue dot) object
`LocationDisplayRule`	`getDefaultDisplayRule()` Gets the default `LocationDisplayRule`
`LocationDisplayRule`	`getDisplayRule(MPLocation location)` Gets the `LocationDisplayRule` currently being used by the given `MPLocation`
`LocationDisplayRule`	`getDisplayRule(java.lang.String type)` Gets the `LocationDisplayRule` with the given type (name)
`java.util.List<LocationDisplayRule>`	`getDisplayRules()` Gets the full list of `LocationDisplayRule`, if available
`java.util.HashMap<java.lang.String,LocationDisplayRule>`	`getDisplayRulesForLocations(java.util.List<MPLocation> locations)` Gets the `LocationDisplayRule`s currently being used by the given `MPLocation`s
`FloorSelectorInterface`	`getFloorSelector()` Get the floor selector control object.
`MPLocation`	`getLocation(com.google.android.gms.maps.model.Marker marker)` Get a `MPLocation` by marker reference.
`MapStyle`	`getMapStyle()` Gets the current map style
`java.util.List<MapStyle>`	`getMapStyles()` Deprecated. use `MapsIndoors.getMapStyles()`
`int`	`getMapViewPaddingBottom()` Gets the Map View bottom padding
`int`	`getMapViewPaddingEnd()` Gets the Map View right padding
`int`	`getMapViewPaddingStart()` Gets the Map View left padding
`int`	`getMapViewPaddingTop()` Gets the Map View top padding
`PositionIndicator`	`getPositionIndicator()` Get the position indicator (user location icon)
`PositionIndicator`	`getPositionMarker()` Deprecated. Use `getCurrentPosition()` instead
`int`	`getSearchResultCount()` Gets the last search result object count
`java.util.List<MPLocation>`	`getSearchResults()` Get the search results from the last call to any of the `displaySearchResults()` methods
`void`	`init(OnLoadingDataReadyListener onLoadingDataReadyListener)` Initializes `MapControl`
`boolean`	`isFloorSelectorEnabled()` Returns the current state of the current `FloorSelectorInterface`.
`boolean`	`isPOIHighlightEnabled()` Checks if location area highlight is enabled
`boolean`	`isReady()` Returns true if MapControl has been initialized and is ready to be used
`boolean`	`isTrackingPosition()` Checks whether position tracking is enabled or not
`boolean`	`isUserPositionShown()` Returns the current visibility state of the user location icon (blue dot)
`void`	`onDestroy()` Call this method from the parent Activity/Fragment's corresponding method.
`void`	`onLowMemory()` Call this method from the parent Activity/Fragment's corresponding method.
`void`	`onPause()` Call this method from the parent Activity/Fragment's corresponding method.
`void`	`onRestoreInstanceState(android.os.Bundle savedInstanceState)` Call this method from the parent Activity/Fragment's corresponding method.
`void`	`onResume()` Call this method from the parent Activity/Fragment's corresponding method.
`void`	`onSaveInstanceState(android.os.Bundle outState)` Call this method from the parent Activity/Fragment's corresponding method.
`void`	`onStart()` Call this method from the parent Activity/Fragment's corresponding method.
`void`	`onStop()` Call this method from the parent Activity/Fragment's corresponding method.
`void`	`refreshMap()` Forces a map update
`void`	`removeOnCameraIdleListener(com.google.android.gms.maps.GoogleMap.OnCameraIdleListener onCameraIdleListener)` Removes the callback added with `addOnCameraIdleListener(GoogleMap.OnCameraIdleListener)`
`void`	`removeOnCameraMoveCanceledListener(com.google.android.gms.maps.GoogleMap.OnCameraMoveCanceledListener onCameraMoveCanceledListener)` Removes the callback added with `addOnCameraMoveCanceledListener(GoogleMap.OnCameraMoveCanceledListener)`
`void`	`removeOnCameraMoveListener(com.google.android.gms.maps.GoogleMap.OnCameraMoveListener onCameraMoveListener)` Removes the callback added with `addOnCameraMoveListener(GoogleMap.OnCameraMoveListener)`
`void`	`removeOnCameraMoveStartedListener(com.google.android.gms.maps.GoogleMap.OnCameraMoveStartedListener onCameraMoveStartedListener)` Removes the callback added with `addOnCameraMoveStartedListener(GoogleMap.OnCameraMoveStartedListener)`
`void`	`resetDisplayRule(java.util.List<MPLocation> locations)` Sets the display rule of the given `MPLocation` set to their default one (set from the CMS)
`void`	`resetDisplayRule(MPLocation location)` Sets the display rule of the given `MPLocation` to its default one (set from the CMS)
`void`	`selectFloor(int floorIndex)` Sets the current visible floor to the given z-index one
`void`	`selectLocation(MPLocation location)` Selects the given `MPLocation`.
`void`	`selectLocation(MPLocation location, boolean zoomToLocationMinZoomLevel)` Selects the given `MPLocation`.
`void`	`selectLocation(MPLocation location, boolean animateCamera, boolean zoomToLocationMinZoomLevel, boolean showInfoWindow)` Selects the given `MPLocation`.
`void`	`selectLocation(MPLocation location, boolean animateCamera, boolean zoomToLocationMinZoomLevel, boolean showInfoWindow, boolean userTriggered)` Selects the given `MPLocation`.
`void`	`setBuildingOutlineShowingZoomLevel(int buildingOutlineShowingZoomLevel)` Sets the zoom level from which the building outline should be rendered
`void`	`setBuildingOutlineStrokeColor(int strokeColor)` Sets the building outline color
`void`	`setCacheScheme(int scheme)` Deprecated. use `@MPTileManager.setTileCacheStrategy(TileCacheStrategy)`
`void`	`setClickedPOIHighlightFillColor(int fillColor)` Sets the selected area's fill color
`void`	`setClickedPOIHighlightOutlineStrokeColor(int strokeColor)` Sets the selected area's stroke color
`void`	`setClickedPOIHighlightOutlineStrokeWidth(float strokeWidth)` Sets the selected area's stroke width
`void`	`setClickedPOIHighlightShowingZoomLevel(float zoomLevel)` Sets the zoom level a selected area will start showing
`void`	`setCurrentPosition(PositionResult position)` Manually sets the user ("blue dot") position
`void`	`setDefaultDisplayRule(LocationDisplayRule displayRule)` Sets the default `LocationDisplayRule`
`void`	`setDisplayRule(LocationDisplayRule displayRule, java.util.List<MPLocation> locations)` Sets a `LocationDisplayRule` on given `MPLocation` set
`void`	`setDisplayRule(LocationDisplayRule displayRule, MPLocation location)` Sets a `LocationDisplayRule` on a single `MPLocation`
`void`	`setDisplayRule(java.lang.String displayRuleName, java.util.List<MPLocation> locations)` Sets a `LocationDisplayRule` on the given `MPLocation` set
`void`	`setDisplayRule(java.lang.String displayRuleName, MPLocation location)` Sets a `LocationDisplayRule` on the given `MPLocation`
`void`	`setDisplayRuleDefaultIconSize(int size)` Overwrites the display rules default icon size
`void`	`setDisplayRuleDefaultLabelMaxCharLength(int maxCharLength)` Overwrites the label's max char length on ALL display rules
`void`	`setFloorSelector(FloorSelectorInterface floorSelector)` Replaces the embedded FloorSelector with the given custom one.
`void`	`setGoogleMap(com.google.android.gms.maps.GoogleMap googleMap, android.view.View view)` Sets the Google Map and its parent view
`void`	`setInfoWindowAdapter(com.google.android.gms.maps.GoogleMap.InfoWindowAdapter adapter)` A convenience `GoogleMap.setInfoWindowAdapter(GoogleMap.InfoWindowAdapter)` wrapper
`void`	`setLocationClusterImageAdapter(MPLocationClusterImageAdapter locationClusterImageAdapter)` Sets the given `MPLocationClusterImageAdapter` handler
`void`	`setLocationClusteringEnabled(boolean enable)` Enables/disables marker clustering
`void`	`setLocationHideOnIconOverlapEnabled(boolean enable)` Enables/disables marker hiding on icon overlap
`void`	`setMapLabelFont(android.graphics.Typeface typeface, int color, boolean showHalo)` Changes the font of the maps marker labels
`void`	`setMapLabelTextSize(int textSize)` Changes the text size of the maps marker labels
`void`	`setMapPadding(int start, int top, int end, int bottom)` Sets padding on the map
`void`	`setMapStyle(MapStyle mapStyle)` Sets the Google Map's style to its default one
`void`	`setOnCurrentBuildingChangedListener(OnBuildingFoundAtCameraTargetListener onBuildingFoundAtCameraTargetListener)` Receive notifications when the current building changes
`void`	`setOnCurrentVenueChangedListener(OnVenueFoundAtCameraTargetListener onVenueFoundAtCameraTargetListener)` Receive notifications when the map camera target enters a `Venue` (its boundaries)
`void`	`setOnFloorUpdateListener(OnFloorUpdateListener onFloorUpdateListener)` Set up a listener object to catch floor changes made by either the user or the positioning service
`void`	`setOnLocationClusterClickListener(OnLocationClusterClickListener onLocationClusterClickListener)` Sets the given `OnLocationClusterClickListener` handler
`void`	`setOnLocationSelectedListener(OnLocationSelectedListener onLocationSelectedListener)` Sets a listener for when a location gets selected (programmatically or user-triggered)
`void`	`setOnMapClickListener(OnMapClickListener onMapClickListener)` Set the map click listener.
`void`	`setOnMapLongClickListener(OnMapLongClickListener onMapLongClickListener)` Sets the long map click listener.
`void`	`setOnMarkerClickListener(com.google.android.gms.maps.GoogleMap.OnMarkerClickListener onMarkerClickListener)` Set the marker click listener.
`void`	`setOnMarkerDragListener(com.google.android.gms.maps.GoogleMap.OnMarkerDragListener onMarkerDragListener)` Set the marker drag listener.
`void`	`setOnMarkerInfoWindowClickListener(com.google.android.gms.maps.GoogleMap.OnInfoWindowClickListener onInfoWindowClickListener)` Set the marker info window click listener.
`void`	`setOnMarkerInfoWindowCloseListener(com.google.android.gms.maps.GoogleMap.OnInfoWindowCloseListener onMarkerInfoWindowCloseListener)` Set the marker info window click listener.
`void`	`setOnMarkerInfoWindowLongClickListener(com.google.android.gms.maps.GoogleMap.OnInfoWindowLongClickListener onMarkerInfoWindowLongClickListener)` Set the marker info window long click listener.
`void`	`setOnWillUpdateLocationsOnMap(OnWillUpdateLocationsOnMap listener)`
`void`	`setTileFadeIn(boolean enableTileFadeIn)` Enable fade-in effect on MapsIndoors tiles.
`void`	`setTileSize(int tileSize)` Deprecated. Use `setTileSize(TileSize)` instead
`void`	`setTileSize(TileSize tileSize)`
`void`	`setTrackingPositionTiltAngle(float angle)` When in tracking mode, sets the camera's tilt to the given one
`boolean`	`setUserLocationIconFromDisplayRule(LocationDisplayRule locationDisplayRule)` Deprecated. Use `PositionIndicator.setIconFromDisplayRule(LocationDisplayRule)` instead
`void`	`showBuildingOutline(boolean show)` Enables the rendering of the `Building` on focus's floor outline
`void`	`showInfoWindowOnClickedLocation(boolean show)` Enables/disables the info window on user-selected locations
`void`	`showUserPosition(boolean show)` Renders the icon set with `setUserLocationIconFromDisplayRule(LocationDisplayRule)` at the last known user position on the map
`boolean`	`trackUserPosition(boolean enableTracking)` Enables/disables user position tracking (camera following the blue-dot marker)
`boolean`	`trackUserPosition(boolean enableTracking, boolean bearingCoupledWithCamera)` Deprecated. As of 3.9.1, this method is replaced by `trackUserPosition(boolean)`
`void`	`unbindFromMap()` Unbinds `MapControl` from the current `GoogleMap` and view it's attached to
`void`	`updatePosition(PositionResult positionResult)` Updates the blue dot, whatever its status is

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TILE_SIZE_X1
```
@Deprecated
public static final int TILE_SIZE_X1
```
    Deprecated.
    
    A 256x256 pixel tile
    
    See Also:
    
    Constant Field Values
  - TILE_SIZE_X2
```
@Deprecated
public static final int TILE_SIZE_X2
```
    Deprecated.
    
    A 512x512 pixel tile
    
    See Also:
    
    Constant Field Values
  - TILE_CACHESCHEME_NONE
```
@Deprecated
public static final int TILE_CACHESCHEME_NONE
```
    Deprecated.
    
    No caching. this is the default setting
    
    See Also:
    
    Constant Field Values
  - TILE_CACHESCHEME_TEMPORARY
```
@Deprecated
public static final int TILE_CACHESCHEME_TEMPORARY
```
    Deprecated.
    
    Keeps tiles in a memory cache. Keeps tiles while the app is running
    
    See Also:
    
    Constant Field Values
  - TILE_CACHESCHEME_PERSISTENT
```
@Deprecated
public static final int TILE_CACHESCHEME_PERSISTENT
```
    Deprecated.
    
    Writes tiles to files and keeps them while the app is installed
    
    See Also:
    
    Constant Field Values
  - TILE_CACHESCHEME_OFFLINE
```
@Deprecated
public static final int TILE_CACHESCHEME_OFFLINE
```
    Deprecated.
    
    Extracts tiles from a zip package at startup
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MapControl
```
@UiThread
public MapControl(@NonNull
                            android.content.Context context)
```
    Creates a MapControl instance without having a Google Map object available
    Use setGoogleMap(GoogleMap, View) to set the GoogleMap object and its parent view
    
    Parameters:
    
    context - The context
    
    Throws:
    
    MapsIndoorsException - if the SDK wasn't initialized yet
    
    java.lang.IllegalStateException - if this wasn't invoked from the UI Thread
    
    MapsIndoorsException - if more instances were created than supported
- Method Detail
  - init
```
@UiThread
public final void init(OnLoadingDataReadyListener onLoadingDataReadyListener)
```
    Initializes MapControl
    
    Parameters:
    
    onLoadingDataReadyListener - An optional listener that will be called on the UI Thread
    
    Throws:
    
    java.lang.IllegalStateException - if this wasn't invoked from the UI Thread
  - isReady
```
public final boolean isReady()
```
    Returns true if MapControl has been initialized and is ready to be used
    
    Returns:
    
    true if MapControl is done initializing/synchronizing, false if MapControl is either synchronizing or it is terminating (by invoking onDestroy())
    
    Since:
    
    3.0.0
  - clearMap
```
@UiThread
public final void clearMap()
```
    Invoke this method to restore the map to its default state (POIs shown based on their display rules, etc.)
    
    Throws:
    
    java.lang.IllegalStateException - if this wasn't invoked from the UI Thread
  - refreshMap
```
@AnyThread
public final void refreshMap()
```
    Forces a map update
    
    Since:
    
    2.0.6
  - setGoogleMap
```
@UiThread
public final void setGoogleMap(@NonNull
                                         com.google.android.gms.maps.GoogleMap googleMap,
                                         @NonNull
                                         android.view.View view)
```
    Sets the Google Map and its parent view
    
    Parameters:
    
    googleMap - The GoogleMap object
    
    view - The View the map is child of
    
    Throws:
    
    java.lang.IllegalStateException - if this wasn't invoked from the UI Thread
    
    Since:
    
    2.0.5
  - setTileFadeIn
```
public void setTileFadeIn(boolean enableTileFadeIn)
```
    Enable fade-in effect on MapsIndoors tiles. Changes will be reflected on the map upon changing floors. Default behavior is enabled fade-in.
    
    Parameters:
    
    enableTileFadeIn - - enable fade-in
    
    Since:
    
    3.8.5
  - bindToMap
```
@Deprecated
 @UiThread
public final void bindToMap(com.google.android.gms.maps.GoogleMap googleMap,
                                                   android.view.View view)
```
    Deprecated.
    
    Binds MapControl to the given GoogleMap and view objects
    
    Parameters:
    
    googleMap - A GoogleMap instance
    
    view - The View the given GoogleMap instance is attached to
    
    Since:
    
    3.2.0
  - unbindFromMap
```
@UiThread
public final void unbindFromMap()
```
    Unbinds MapControl from the current GoogleMap and view it's attached to
    
    Since:
    
    3.2.0
  - setDisplayRule
```
@AnyThread
public final void setDisplayRule(@Nullable
                                            LocationDisplayRule displayRule,
                                            @Nullable
                                            MPLocation location)
```
    Sets a LocationDisplayRule on a single MPLocation
    This display rule takes precedence over more general displayrules like the type-display-rule
    
    Parameters:
    
    displayRule - The LocationDisplayRule to apply to the given MPLocation
    
    location - A MPLocation
    
    Since:
    
    3.3.0
  - setDisplayRule
```
@AnyThread
public final void setDisplayRule(@Nullable
                                            LocationDisplayRule displayRule,
                                            @Nullable
                                            java.util.List<MPLocation> locations)
```
    Sets a LocationDisplayRule on given MPLocation set
    This display rule takes precedence over more general displayrules like the type-display-rule
    
    Parameters:
    
    displayRule - The LocationDisplayRule to apply to the given MPLocation
    
    locations - A list of MPLocation that will be set to the given LocationDisplayRule
    
    Since:
    
    3.3.0
  - setDisplayRule
```
@AnyThread
public final void setDisplayRule(@Nullable
                                            java.lang.String displayRuleName,
                                            @Nullable
                                            MPLocation location)
```
    Sets a LocationDisplayRule on the given MPLocation
    This display rule takes precedence over more general display rules like the type-display-rule
    
    Parameters:
    
    displayRuleName - The name of the LocationDisplayRule that should be applied to the given MPLocation
    
    location - A MPLocation
    
    Since:
    
    3.3.0
  - setDisplayRule
```
@AnyThread
public final void setDisplayRule(@Nullable
                                            java.lang.String displayRuleName,
                                            @Nullable
                                            java.util.List<MPLocation> locations)
```
    Sets a LocationDisplayRule on the given MPLocation set
    This display rule takes precedence over more general display rules like the type-display-rule
    
    Parameters:
    
    displayRuleName - The name of the LocationDisplayRule that should be applied to the given MPLocation
    
    locations - A list of MPLocation that will be set to the given LocationDisplayRule
    
    Since:
    
    3.3.0
  - getDisplayRule
```
@Nullable
public final LocationDisplayRule getDisplayRule(java.lang.String type)
```
    Gets the LocationDisplayRule with the given type (name)
    
    Parameters:
    
    type - The LocationDisplayRule name
    
    Returns:
    
    A LocationDisplayRule or null if a LocationDisplayRule with the given name wasn't found
    
    Since:
    
    3.1.0
  - getDisplayRule
```
@Nullable
 @AnyThread
public final LocationDisplayRule getDisplayRule(@Nullable
                                                                      MPLocation location)
```
    Gets the LocationDisplayRule currently being used by the given MPLocation
    
    Parameters:
    
    location - The MPLocation we want to get its current LocationDisplayRule
    
    Returns:
    
    A LocationDisplayRule or null (if the given location has an overridden icon set in the CMS or if it is null)
    
    Since:
    
    3.3.0
  - getDisplayRules
```
@NonNull
public final java.util.List<LocationDisplayRule> getDisplayRules()
```
    Gets the full list of LocationDisplayRule, if available
    
    Returns:
    
    A list of LocationDisplayRule, if available
    
    Since:
    
    3.1.0
  - getDefaultDisplayRule
```
@NonNull
public final LocationDisplayRule getDefaultDisplayRule()
```
    Gets the default LocationDisplayRule
    
    Returns:
    
    The current default LocationDisplayRule
    
    Since:
    
    3.0.0
    
    See Also:
    
    setDefaultDisplayRule()
  - setDefaultDisplayRule
```
public final void setDefaultDisplayRule(LocationDisplayRule displayRule)
```
    Sets the default LocationDisplayRule
    The default display settings used by MPMapControl to display a location. Modify this object to change the default visual appearance of a location. The default appearance only applies for locations that has no other references to a display rule.
    
    Parameters:
    
    displayRule - A new LocationDisplayRule to be set as the default, or null to revert to the SDK's one
    
    Since:
    
    3.0.0
  - setDisplayRuleDefaultIconSize
```
public final void setDisplayRuleDefaultIconSize(int size)
```
    Overwrites the display rules default icon size
    Applies only to those display rules that don't specify the size
    
    Parameters:
    
    size - The new default uniform POI icon size, in dp. Set to zero to use the SDK's default value
    
    Since:
    
    2.0.7
  - setDisplayRuleDefaultLabelMaxCharLength
```
public final void setDisplayRuleDefaultLabelMaxCharLength(int maxCharLength)
```
    Overwrites the label's max char length on ALL display rules
    
    Parameters:
    
    maxCharLength - The desired char count or LocationDisplayRule.DEFAULT_MARKER_LABEL_LENGTH_NO_CAP to disable capping
    
    Since:
    
    2.0.0
  - addDisplayRule
```
public final void addDisplayRule(LocationDisplayRule locationDisplayRule)
```
    Adds a custom display rule
    
    Parameters:
    
    locationDisplayRule - The new display rule to add
    
    Throws:
    
    java.lang.IllegalArgumentException - if the given LocationDisplayRule name is currently being used
    
    Since:
    
    2.0.0
  - addDisplayRule
```
public final void addDisplayRule(LocationDisplayRule locationDisplayRule,
                                 OnResultReadyListener onResultReadyListener)
```
    Adds a new display rule
    
    Parameters:
    
    locationDisplayRule - The new display rule to add
    
    onResultReadyListener - A callback invoked once this method is done loading resources, if any
    
    Throws:
    
    java.lang.IllegalArgumentException - if the given LocationDisplayRule name is currently being used
    
    Since:
    
    2.0.0
  - addDisplayRules
```
public final void addDisplayRules(java.util.List<LocationDisplayRule> displayRuleList)
```
    Adds a new set of custom display rules
    
    Parameters:
    
    displayRuleList - The set of new display rules to be added
    
    Throws:
    
    java.lang.IllegalArgumentException - if the given LocationDisplayRule name is currently being used
    
    Since:
    
    2.0.0
  - addDisplayRules
```
public final void addDisplayRules(java.util.List<LocationDisplayRule> displayRuleList,
                                  OnResultReadyListener onResultReadyListener)
```
    Add rules needed to display locations correctly.
    
    Parameters:
    
    displayRuleList - The new display rule to add
    
    onResultReadyListener - A callback invoked once this method is done loading resources, if any
    
    Throws:
    
    java.lang.IllegalArgumentException - if the given LocationDisplayRule name is currently being used
    
    Since:
    
    2.0.0
  - getDisplayRulesForLocations
```
@Nullable
 @AnyThread
public final java.util.HashMap<java.lang.String,LocationDisplayRule> getDisplayRulesForLocations(@NonNull
                                                                                                                       java.util.List<MPLocation> locations)
```
    Gets the LocationDisplayRules currently being used by the given MPLocations
    
    Parameters:
    
    locations - List of MPLocations we want to get current LocationDisplayRules for.
    
    Returns:
    
    A hashmap from MPLocation.id to LocationDisplayRule
    
    Since:
    
    3.3.0
  - resetDisplayRule
```
@AnyThread
public final void resetDisplayRule(@Nullable
                                              MPLocation location)
```
    Sets the display rule of the given MPLocation to its default one (set from the CMS)
    
    Parameters:
    
    location - The MPLocation we want to set its display rule to its default (set from the CMS)
    
    Since:
    
    3.3.0
  - resetDisplayRule
```
@AnyThread
public final void resetDisplayRule(@Nullable
                                              java.util.List<MPLocation> locations)
```
    Sets the display rule of the given MPLocation set to their default one (set from the CMS)
    
    Parameters:
    
    locations - The MPLocation set we want to set their display rule to their default (set from the CMS)
    
    Since:
    
    3.3.0
  - getSearchResultCount
```
public final int getSearchResultCount()
```
    Gets the last search result object count
    
    Returns:
    
    The last search result object count
  - getSearchResults
```
@NonNull
public final java.util.List<MPLocation> getSearchResults()
```
    Get the search results from the last call to any of the displaySearchResults() methods
    
    Returns:
    
    A list of MPLocation objects
  - displaySearchResults
```
@AnyThread
public final boolean displaySearchResults(@NonNull
                                                     java.util.List<MPLocation> locations)
```
    Use this method to display temporary locations, not points of interests location. Use clearMap() to exit this state
    
    Parameters:
    
    locations - The temporary locations.
    
    Returns:
    
    False if any of these errors happened: no context, no google map, no locations to show. True otherwise
    
    Since:
    
    2.0.0
  - displaySearchResults
```
@AnyThread
public final boolean displaySearchResults(@NonNull
                                                     java.util.List<MPLocation> locations,
                                                     boolean animateCamera)
```
    Use this method to display temporary locations, not points of interests location. Use clearMap() to exit this state
    
    Parameters:
    
    locations - The temporary locations.
    
    animateCamera - True if the camera should animate to the locations center, false to just move there
    
    Returns:
    
    False if any of these errors happened: no context, no google map, no locations to show. True otherwise
    
    Since:
    
    2.0.0
  - displaySearchResults
```
@AnyThread
public final boolean displaySearchResults(@NonNull
                                                     java.util.List<MPLocation> locations,
                                                     @Nullable
                                                     ReadyListener readyListener)
```
    Use this method to display temporary locations, not points of interests location. Use clearMap() to exit this state
    
    Parameters:
    
    locations - The temporary locations.
    
    readyListener -
    
    Returns:
    
    False if any of these errors happened: no context, no google map, no locations to show. True otherwise
    
    Since:
    
    3.0.0
  - displaySearchResults
```
@AnyThread
public final boolean displaySearchResults(@NonNull
                                                     java.util.List<MPLocation> locations,
                                                     boolean animateCamera,
                                                     int cameraPadding)
```
    Use this method to display temporary locations, not points of interests location. Use clearMap() to exit this state
    
    Parameters:
    
    locations - The temporary locations.
    
    animateCamera - True if the camera should animate to the locations center, false to just move there
    
    cameraPadding - A padding value (in dp) between the given locations bounding box and the viewport
    
    Returns:
    
    False if any of these errors happened: no context, no google map, no locations to show. True otherwise
    
    Since:
    
    2.0.0
  - displaySearchResults
```
@AnyThread
public final boolean displaySearchResults(@NonNull
                                                     java.util.List<MPLocation> locations,
                                                     boolean animateCamera,
                                                     int cameraPadding,
                                                     boolean showInfoWindow)
```
    Use this method to display temporary locations, not points of interests location. Use clearMap() to exit this state
    
    Parameters:
    
    locations - The temporary locations.
    
    animateCamera - True if the camera should animate to the locations center, false to just move there
    
    cameraPadding - A padding value (in dp) between the given locations bounding box and the viewport
    
    showInfoWindow - True to show the info window if there is only one location in the list
    
    Returns:
    
    False if any of these errors happened: no context, no google map, no locations to show. True otherwise
    
    Since:
    
    2.0.0
  - displaySearchResults
```
@AnyThread
public final boolean displaySearchResults(@NonNull
                                                     java.util.List<MPLocation> locations,
                                                     boolean animateCamera,
                                                     int cameraPadding,
                                                     @Nullable
                                                     ReadyListener readyListener)
```
    Use this method to display temporary locations, not points of interests location. Use clearMap() to exit this state
    
    Parameters:
    
    locations - The temporary locations.
    
    animateCamera - True if the camera should animate to the locations center, false to just move there
    
    cameraPadding - A padding value (in dp) between the given locations bounding box and the viewport
    
    Returns:
    
    False if any of these errors happened: no context, no google map, no locations to show. True otherwise
    
    Since:
    
    2.0.0
  - displaySearchResults
```
@AnyThread
public final boolean displaySearchResults(@NonNull
                                                     java.util.List<MPLocation> locations,
                                                     boolean animateCamera,
                                                     int cameraPadding,
                                                     boolean showInfoWindow,
                                                     @Nullable
                                                     com.google.android.gms.maps.CameraUpdate googleMapCameraUpdate,
                                                     int durationMs,
                                                     com.google.android.gms.maps.GoogleMap.CancelableCallback googleMapCancelableCallback)
```
    Use this method to display temporary locations, not points of interests location. Use clearMap() to exit this state
    
    Parameters:
    
    locations - The temporary locations.
    
    animateCamera - True if the camera should animate to the locations center, false to just move there
    
    googleMapCameraUpdate - A CameraUpdate object. See CameraUpdate
    
    durationMs - The duration of the animation in milliseconds. This must be strictly positive, otherwise an IllegalArgumentException will be thrown.
    
    googleMapCancelableCallback - An optional callback to be notified from the Android UI thread when the animation stops. If the animation stops due to its natural completion, the callback will be notified with onFinish(). If the animation stops due to interruption by a later camera movement or a user gesture, onCancel() will be called. The callback should not attempt to move or animate the camera in its cancellation method. If a callback isn't required, leave it as null.
    
    Returns:
    
    False if any of these errors happened: no context, no google map, no locations to show. True otherwise
    
    Since:
    
    2.0.0
  - displaySearchResults
```
@AnyThread
public final boolean displaySearchResults(@NonNull
                                                     java.util.List<MPLocation> locations,
                                                     boolean animateCamera,
                                                     int cameraPadding,
                                                     boolean showInfoWindow,
                                                     @Nullable
                                                     com.google.android.gms.maps.CameraUpdate googleMapCameraUpdate,
                                                     int durationMs,
                                                     com.google.android.gms.maps.GoogleMap.CancelableCallback googleMapCancelableCallback,
                                                     @Nullable
                                                     ReadyListener readyListener)
```
    Use this method to display temporary locations, not points of interests location. Use clearMap() to exit this state
    
    Parameters:
    
    locations - The temporary locations.
    
    animateCamera - True if the camera should animate to the locations center, false to just move there
    
    cameraPadding - A padding value (in dp) between the given locations bounding box and the viewport
    
    showInfoWindow - True to show the info window if there is only one location in the list
    
    googleMapCameraUpdate - A CameraUpdate object. See CameraUpdate
    
    durationMs - The duration of the animation in milliseconds. This must be strictly positive, otherwise an IllegalArgumentException will be thrown.
    
    googleMapCancelableCallback - An optional callback to be notified from the Android UI thread when the animation stops. If the animation stops due to its natural completion, the callback will be notified with onFinish(). If the animation stops due to interruption by a later camera movement or a user gesture, onCancel() will be called. The callback should not attempt to move or animate the camera in its cancellation method. If a callback isn't required, leave it as null.
    
    readyListener - An optional callback to be notified once the method is done (failed to run, end of camera animations, etc.)
    
    Returns:
    
    False if any of these errors happened: no context, no google map, no locations to show. True otherwise
    
    Since:
    
    3.2.0
  - enableFloorSelector
```
public final void enableFloorSelector(boolean enable)
```
    Enables or disables the FloorSelectorInterface, i.e. hiding the View from the MapControl The MapControl will still receive relevant events on floor updates, building change etc. The Interface will also receive the events, making it possible to enable/disable in real time, without refreshing the map.
    
    Parameters:
    
    enable - Should the FloorSelectorInterface be enabled?
  - setFloorSelector
```
public final void setFloorSelector(FloorSelectorInterface floorSelector)
```
    Replaces the embedded FloorSelector with the given custom one.
    
    Parameters:
    
    floorSelector - View that implements FloorSelectorInterface
  - enableClickedPOIHighlight
```
@UiThread
public final void enableClickedPOIHighlight(boolean enable)
```
    Enables/disables POI area highlighting
    Enabled by default
    
    Parameters:
    
    enable - true to enable area highlighting, false to disable
    
    Throws:
    
    java.lang.IllegalStateException - if this wasn't invoked from the UI Thread
    
    Since:
    
    3.0.0
  - getClickedPOIHighlightFillColor
```
@AnyThread
public final int getClickedPOIHighlightFillColor()
```
    Get the selected area's fill color
    
    Returns:
    
    The color value in the AARRGGBB format
    
    Since:
    
    3.0.0
  - getClickedPOIHighlightOutlineStrokeColor
```
@AnyThread
public final int getClickedPOIHighlightOutlineStrokeColor()
```
    Get the selected area's stroke color
    
    Returns:
    
    The color value in the AARRGGBB format
    
    Since:
    
    3.0.0
  - getClickedPOIHighlightOutlineStrokeWidth
```
@AnyThread
public final float getClickedPOIHighlightOutlineStrokeWidth()
```
    Get the selected area's stroke width
    
    Returns:
    
    The stroke width, in pixels
    
    Since:
    
    3.0.0
  - getClickedPOIHighlightShowingZoomLevel
```
@AnyThread
public final float getClickedPOIHighlightShowingZoomLevel()
```
    Get the zoom level a selected area will start showing
    
    Returns:
    
    The zoom level a selected area will be shown
    
    Since:
    
    3.0.0
  - setClickedPOIHighlightFillColor
```
@UiThread
public final void setClickedPOIHighlightFillColor(int fillColor)
```
    Sets the selected area's fill color
    
    Parameters:
    
    fillColor - A color value in the AARRGGBB format
    
    Throws:
    
    java.lang.IllegalStateException - if this wasn't invoked from the UI Thread
    
    Since:
    
    3.0.0
  - setClickedPOIHighlightOutlineStrokeColor
```
@UiThread
public final void setClickedPOIHighlightOutlineStrokeColor(int strokeColor)
```
    Sets the selected area's stroke color
    
    Parameters:
    
    strokeColor - A color value in the AARRGGBB format
    
    Throws:
    
    java.lang.IllegalStateException - if this wasn't invoked from the UI Thread
    
    Since:
    
    3.0.0
  - setClickedPOIHighlightOutlineStrokeWidth
```
@UiThread
public final void setClickedPOIHighlightOutlineStrokeWidth(float strokeWidth)
```
    Sets the selected area's stroke width
    
    Parameters:
    
    strokeWidth - The stroke width, in pixels
    
    Throws:
    
    java.lang.IllegalStateException - if this wasn't invoked from the UI Thread
    
    Since:
    
    3.0.0
  - setClickedPOIHighlightShowingZoomLevel
```
@UiThread
public final void setClickedPOIHighlightShowingZoomLevel(float zoomLevel)
```
    Sets the zoom level a selected area will start showing
    
    Parameters:
    
    zoomLevel - The zoom level a selected area will be shown
    
    Throws:
    
    java.lang.IllegalStateException - if this wasn't invoked from the UI Thread
    
    Since:
    
    3.0.0
  - showBuildingOutline
```
public final void showBuildingOutline(boolean show)
```
    Enables the rendering of the Building on focus's floor outline
    
    Parameters:
    
    show - true to render the current floor's outline, false otherwise
  - isPOIHighlightEnabled
```
@AnyThread
public final boolean isPOIHighlightEnabled()
```
    Checks if location area highlight is enabled
    
    Returns:
    
    true if highlight is enabled (with enableClickedPOIHighlight(boolean)), false otherwise
    
    Since:
    
    3.0.0
  - setInfoWindowAdapter
```
@UiThread
public final void setInfoWindowAdapter(com.google.android.gms.maps.GoogleMap.InfoWindowAdapter adapter)
```
    A convenience GoogleMap.setInfoWindowAdapter(GoogleMap.InfoWindowAdapter) wrapper
    
    Parameters:
    
    adapter - The adapter to use for info window contents, or null to use the default content rendering in info windows.
    
    Throws:
    
    java.lang.IllegalStateException - if this wasn't invoked from the UI Thread
  - setLocationClusterImageAdapter
```
public final void setLocationClusterImageAdapter(MPLocationClusterImageAdapter locationClusterImageAdapter)
```
    Sets the given MPLocationClusterImageAdapter handler
    
    Parameters:
    
    locationClusterImageAdapter - A custom MPLocationClusterImageAdapter handler. Set to null to use the default one
    
    Since:
    
    3.0.0
  - setLocationClusteringEnabled
```
public final void setLocationClusteringEnabled(boolean enable)
```
    Enables/disables marker clustering
    At the moment, invoking this method once MapControl.init() has been called, has no effect
    
    Parameters:
    
    enable - true to enable marker clustering, false otherwise
    
    Throws:
    
    MapsIndoorsException - if this was invoked after MapControl.init() was called
    
    Since:
    
    3.0.0
  - setLocationHideOnIconOverlapEnabled
```
public final void setLocationHideOnIconOverlapEnabled(boolean enable)
```
    Enables/disables marker hiding on icon overlap
    This method enables/disables hiding icons when colliding with others
    
    At the moment, invoking this method once MapControl.init() has been called, has no effect
    
    Parameters:
    
    enable - true to enable marker hiding when overlapping with others, false otherwise
    
    Throws:
    
    MapsIndoorsException - if this was invoked after MapControl.init() was called
    
    Since:
    
    3.2.0
  - setMapPadding
```
public final void setMapPadding(int start,
                                int top,
                                int end,
                                int bottom)
```
    Sets padding on the map
    
    Parameters:
    
    start - Left padding, in pixels
    
    top - Top padding, in pixels
    
    end - Right padding, in pixels
    
    bottom - Bottom padding, in pixels
    
    Since:
    
    3.0.0
  - setMapStyle
```
@UiThread
public final void setMapStyle(MapStyle mapStyle)
```
    Sets the Google Map's style to its default one
  - getMapStyle
```
@Nullable
 @AnyThread
public final MapStyle getMapStyle()
```
    Gets the current map style
    
    Returns:
    
    The current MapStyle or null if data isn't yet available
    
    Since:
    
    3.1.0
  - getMapStyles
```
@NonNull
 @AnyThread
public final java.util.List<MapStyle> getMapStyles()
```
    Deprecated. use MapsIndoors.getMapStyles()
    
    Gets a list of available map styles
    
    Returns:
    
    A list of MapStyle or an empty list if data isn't yet available
  - getMapViewPaddingBottom
```
public final int getMapViewPaddingBottom()
```
    Gets the Map View bottom padding
    
    Returns:
    
    Padding in pixels
    
    Since:
    
    3.0.0
  - getMapViewPaddingEnd
```
public final int getMapViewPaddingEnd()
```
    Gets the Map View right padding
    
    Returns:
    
    Padding in pixels
    
    Since:
    
    3.0.0
  - getMapViewPaddingStart
```
public final int getMapViewPaddingStart()
```
    Gets the Map View left padding
    
    Returns:
    
    Padding in pixels
    
    Since:
    
    3.0.0
  - getMapViewPaddingTop
```
public final int getMapViewPaddingTop()
```
    Gets the Map View top padding
    
    Returns:
    
    Padding in pixels
    
    Since:
    
    3.0.0
  - setTrackingPositionTiltAngle
```
public final void setTrackingPositionTiltAngle(float angle)
```
    When in tracking mode, sets the camera's tilt to the given one
    
    Parameters:
    
    angle - The angle, in degrees
    
    Since:
    
    2.1.0
  - showInfoWindowOnClickedLocation
```
@AnyThread
public final void showInfoWindowOnClickedLocation(boolean show)
```
    Enables/disables the info window on user-selected locations
    The info window is shown by default when the user selects a location (by tapping on it)
    
    Parameters:
    
    show - true to show the info window on user-selected locations, false otherwise
    
    Since:
    
    3.0.0
  - setUserLocationIconFromDisplayRule
```
@UiThread
 @Deprecated
public final boolean setUserLocationIconFromDisplayRule(LocationDisplayRule locationDisplayRule)
```
    Deprecated. Use PositionIndicator.setIconFromDisplayRule(LocationDisplayRule) instead
    
    Sets the "my location" marker's (aka blue dot) icon using the given LocationDisplayRule
    
    Parameters:
    
    locationDisplayRule - The LocationDisplayRule to use as the user's location icon on the map
    
    Returns:
    
    true if the given location display rule was successfully added, false otherwise
    
    Since:
    
    2.0.3
  - isFloorSelectorEnabled
```
public final boolean isFloorSelectorEnabled()
```
    Returns the current state of the current FloorSelectorInterface.
    
    Returns:
    
    true if enabled (default), false if not.
  - setBuildingOutlineShowingZoomLevel
```
public final void setBuildingOutlineShowingZoomLevel(int buildingOutlineShowingZoomLevel)
```
    Sets the zoom level from which the building outline should be rendered
    
    Parameters:
    
    buildingOutlineShowingZoomLevel - The zoom level, in the range [0, 22]
  - setBuildingOutlineStrokeColor
```
public final void setBuildingOutlineStrokeColor(int strokeColor)
```
    Sets the building outline color
    
    Parameters:
    
    strokeColor - The color as AARRGGBB
  - setTileSize
```
public final void setTileSize(int tileSize)
```
    Deprecated. Use setTileSize(TileSize) instead
    
    Set the indoor floor tile-size for rendering.
    Note that tile sizes depend on the Solution set (it is not mandatory for all MapsIndoors solutions to support all tile sizes)
    
    Parameters:
    
    tileSize - The tile (square) size in pixels (TILE_SIZE_X1, TILE_SIZE_X2)
    
    Throws:
    
    java.lang.IllegalArgumentException - if the argument tileSize is not a valid one (TILE_SIZE_X1, TILE_SIZE_X2)
    
    MapsIndoorsException - if this was invoked after MapControl.init() was called
    
    Since:
    
    2.0.0
  - setTileSize
```
public final void setTileSize(@NonNull
                              TileSize tileSize)
```
  - deSelectLocation
```
@UiThread
public final void deSelectLocation()
```
    Call this to deselect a location previously selected with selectLocation(MPLocation)
  - selectFloor
```
@UiThread
public final void selectFloor(int floorIndex)
```
    Sets the current visible floor to the given z-index one
    For floor names/z-index pairs check the value returned by Building.getFloorHashMap()
    
    Parameters:
    
    floorIndex - A floor z-index
  - selectLocation
```
@UiThread
public final void selectLocation(@Nullable
                                           MPLocation location)
```
    Selects the given MPLocation.
    This will set the camera over it. The camera will animate and a fixed zoom level will be used (21)
    
    Parameters:
    
    location - The MPLocation to be selected, null to deselect the current one
  - selectLocation
```
@UiThread
public final void selectLocation(@Nullable
                                           MPLocation location,
                                           boolean zoomToLocationMinZoomLevel)
```
    Selects the given MPLocation.
    This will set the camera over it. The camera will animate and, if the zoomToLocationMinZoomLevel param is set to true, the location's smallest zoom level (LocationDisplayRule.getZoomLevelOn()) will be used as the camera's target zoom
    
    Parameters:
    
    location - The MPLocation to be selected, null to deselect the current one
    
    zoomToLocationMinZoomLevel - true to use the location's smallest zoom level (LocationDisplayRule.getZoomLevelOn()) will be used as the camera's target zoom
  - selectLocation
```
@UiThread
public final void selectLocation(@Nullable
                                           MPLocation location,
                                           boolean animateCamera,
                                           boolean zoomToLocationMinZoomLevel,
                                           boolean showInfoWindow,
                                           boolean userTriggered)
```
    Selects the given MPLocation.
    This will set the camera over it. The camera will animate and, if the zoomToLocationMinZoomLevel argument is set to true, the location's smallest zoom level (LocationDisplayRule.getZoomLevelOn()) will be used as the camera's target zoom
    
    Parameters:
    
    location - The location to be selected, null to deselect the current one
    
    animateCamera - true if the camera should animate to the location's position, false to just move
    
    zoomToLocationMinZoomLevel - true to use the location's smallest zoom level (LocationDisplayRule.getZoomLevelOn()) will be used as the camera's target zoom
    
    showInfoWindow - true if the Info Window should be shown, false otherwise
    
    userTriggered - true to move the MPLocation marker into view only if it is partially visible. Set to false for the default behaviour
    
    Since:
    
    3.5.0
  - selectLocation
```
@UiThread
public final void selectLocation(@Nullable
                                           MPLocation location,
                                           boolean animateCamera,
                                           boolean zoomToLocationMinZoomLevel,
                                           boolean showInfoWindow)
```
    Selects the given MPLocation.
    This will set the camera over it. The camera will animate and, if the zoomToLocationMinZoomLevel param is set to true, the location's smallest zoom level (LocationDisplayRule.getZoomLevelOn()) will be used as the camera's target zoom
    
    Parameters:
    
    location - The location to be selected, null to deselect the current one
    
    animateCamera - true if the camera should animate to the location's position, false to just move
    
    zoomToLocationMinZoomLevel - true to use the location's smallest zoom level (LocationDisplayRule.getZoomLevelOn()) will be used as the camera's target zoom
    
    showInfoWindow - true if the Info Window should be shown, false otherwise
  - getCurrentBuilding
```
@Nullable
public final Building getCurrentBuilding()
```
    Returns the current visible Building (the one having the viewport's center/target within its bounding box or closest to any of its contour)
    
    Returns:
    
    null if there is no Building at the camera's target; a valid Building otherwise
  - getCurrentBuildingFloor
```
@Nullable
public final Floor getCurrentBuildingFloor()
```
    Returns the current Floor of the current Building in focus
    
    Returns:
    
    The current Floor of the Building in focus, null otherwise
  - getCurrentFloorIndex
```
public final int getCurrentFloorIndex()
```
    Returns the current selected floor index
    
    Returns:
    
    The current floor index or Floor.DEFAULT_GROUND_FLOOR_INDEX if no Building is in focus
  - getCurrentPosition
```
@Nullable
public final PositionResult getCurrentPosition()
```
    Get the current user position (blue dot) object
    
    Returns:
    
    The PositionIndicator object
  - getFloorSelector
```
@Nullable
public final FloorSelectorInterface getFloorSelector()
```
    Get the floor selector control object.
    
    Returns:
    
    floor selector control object.
  - getLocation
```
@Nullable
public final MPLocation getLocation(com.google.android.gms.maps.model.Marker marker)
```
    Get a MPLocation by marker reference.
    
    Parameters:
    
    marker - A Google Map Marker
    
    Returns:
    
    The marker's associated MapsIndoors MPLocation or null
  - getPositionIndicator
```
@NonNull
public final PositionIndicator getPositionIndicator()
```
    Get the position indicator (user location icon)
    
    Returns:
    
    The PositionIndicator object
  - getPositionMarker
```
@Deprecated
 @NonNull
public final PositionIndicator getPositionMarker()
```
    Deprecated. Use getCurrentPosition() instead
    
    Get the current user position (blue dot) object
    
    Returns:
    
    The PositionIndicator object
  - setCurrentPosition
```
@AnyThread
public final void setCurrentPosition(PositionResult position)
```
    Manually sets the user ("blue dot") position
    
    Parameters:
    
    position - A PositionResult or a null to update the marker
    
    Since:
    
    3.0.0
  - showUserPosition
```
public final void showUserPosition(boolean show)
```
    Renders the icon set with setUserLocationIconFromDisplayRule(LocationDisplayRule) at the last known user position on the map
    
    Parameters:
    
    show - True to show, false to hide
  - trackUserPosition
```
@Deprecated
public final boolean trackUserPosition(boolean enableTracking,
                                                   boolean bearingCoupledWithCamera)
```
    Deprecated. As of 3.9.1, this method is replaced by trackUserPosition(boolean)
    
    Enables/disables user position tracking (camera following the blue-dot marker)
    
    Parameters:
    
    enableTracking - true to enable tracking, false to disable
    
    bearingCoupledWithCamera - Not used at the moment
    
    Returns:
    
    true if starting/stopping tracking was successful
    
    Since:
    
    2.0.7
  - trackUserPosition
```
public final boolean trackUserPosition(boolean enableTracking)
```
    Enables/disables user position tracking (camera following the blue-dot marker)
    
    Parameters:
    
    enableTracking - true to enable tracking, false to disable
    
    Returns:
    
    true if starting/stopping tracking was successful
    
    Since:
    
    3.9.1
  - updatePosition
```
@AnyThread
public final void updatePosition(PositionResult positionResult)
```
    Updates the blue dot, whatever its status is
  - isTrackingPosition
```
public final boolean isTrackingPosition()
```
    Checks whether position tracking is enabled or not
    
    Returns:
    
    true if the tracking mode is on, false otherwise
  - isUserPositionShown
```
public final boolean isUserPositionShown()
```
    Returns the current visibility state of the user location icon (blue dot)
    
    Returns:
    
    true if the blue dot marker is being rendered, false otherwise
  - enableLiveData
```
public final void enableLiveData(java.lang.String domainType)
```
    Enables live data on a specific domain and uses MapsIndoors standard graphic implementation
    
    Parameters:
    
    domainType - a domainType string. Use LiveDataDomainTypes for getting the supported strings as constants.
  - enableLiveData
```
public final void enableLiveData(java.lang.String domainType,
                                 OnLiveLocationUpdateListener onLiveLocationUpdateListener)
```
    Enables live data on a specific domain
    
    Parameters:
    
    domainType - a domainType string. Use LiveDataDomainTypes for getting the supported strings as constants.
    
    onLiveLocationUpdateListener - A Listener that returns each location that has received a live update
  - disableLiveData
```
public final void disableLiveData(java.lang.String domainType)
```
    Disables live data on a specific domainType
    
    Parameters:
    
    domainType - a domainType string. Use LiveDataDomainTypes for getting the supported strings as constants.
  - onStart
```
public final void onStart()
```
    Call this method from the parent Activity/Fragment's corresponding method.
    In your Activity/Fragment:
```
     protected void onStart() {
         super.onStart();
         if (mapControl != null) {
             mapControl.onStart();
         }
     }
 
```
    See Also:
    
    Activity.onStart()
  - onStop
```
public final void onStop()
```
    Call this method from the parent Activity/Fragment's corresponding method.
    In your Activity/Fragment:
```
     protected void onStop() {
         super.onStop();
         if (mapControl != null) {
             mapControl.onStop();
         }
     }
 
```
    See Also:
    
    Activity.onStop()
  - onPause
```
public final void onPause()
```
    Call this method from the parent Activity/Fragment's corresponding method.
    In your Activity/Fragment:
```
     protected void onPause() {
         super.onPause();
         if (mapControl != null) {
             mapControl.onPause();
         }
     }
 
```
    See Also:
    
    Activity.onPause()
  - onResume
```
public final void onResume()
```
    Call this method from the parent Activity/Fragment's corresponding method.
    In your Activity/Fragment:
```
     protected void onResume() {
         super.onResume();
         if (mapControl != null) {
             mapControl.onResume();
         }
     }
 
```
    See Also:
    
    Activity.onResume()
  - onLowMemory
```
public final void onLowMemory()
```
    Call this method from the parent Activity/Fragment's corresponding method.
    In your Activity/Fragment:
```
     protected void onLowMemory() {
         super.onLowMemory();
         if (mapControl != null) {
             mapControl.onLowMemory();
         }
     }
 
```
    See Also:
    
    Activity.onLowMemory()
  - onSaveInstanceState
```
public final void onSaveInstanceState(android.os.Bundle outState)
```
    Call this method from the parent Activity/Fragment's corresponding method.
    In your Activity/Fragment:
```
     protected void onSaveInstanceState( Bundle outState ) {
         super.onSaveInstanceState( outState );
         if( mMapControl != null ) {
             mMapControl.onSaveInstanceState( outState );
         }
     }
 
```
    Parameters:
    
    outState - Bundle in which to place your saved state. This value must never be null.
    
    See Also:
    
    Activity.onSaveInstanceState()
  - onRestoreInstanceState
```
public final void onRestoreInstanceState(android.os.Bundle savedInstanceState)
```
    Call this method from the parent Activity/Fragment's corresponding method.
    In your Activity/Fragment:
```
     protected void onRestoreInstanceState( Bundle savedInstanceState ) {
         super.onRestoreInstanceState( savedInstanceState );
         if( mMapControl != null ) {
             mMapControl.onRestoreInstanceState( savedInstanceState );
         }
     }
 
```
    Parameters:
    
    savedInstanceState - The data most recently supplied in onSaveInstanceState(Bundle). This value must never be null.
    
    See Also:
    
    Activity.onRestoreInstanceState()
  - onDestroy
```
public final void onDestroy()
```
    Call this method from the parent Activity/Fragment's corresponding method.
    In your Activity/Fragment:
```
     protected void onDestroy() {
         super.onDestroy();
         if (mapControl != null) {
             mapControl.onDestroy();
             mapControl = null;
         }
     }
 
```
    See Also:
    
    Activity.onDestroy()
  - setCacheScheme
```
@Deprecated
public final void setCacheScheme(int scheme)
```
    Deprecated. use @MPTileManager.setTileCacheStrategy(TileCacheStrategy)
    Sets a caching scheme for tiles
    Options:
    - TILE_CACHESCHEME_NONE: No caching. this is the default setting
    - TILE_CACHESCHEME_TEMPORARY: Keeps tiles in a memory cache. Keeps tiles while the app is running
    - TILE_CACHESCHEME_PERSISTENT: Write tiles to files and keeps them while the app is installed
    - TILE_CACHESCHEME_OFFLINE: Extract tiles from a zip package at startup
    Parameters:
    
    scheme - The caching scheme to use. Default: TILE_CACHESCHEME_NONE
    
    Since:
    
    2.0.0
  - addOnCameraIdleListener
```
public final void addOnCameraIdleListener(com.google.android.gms.maps.GoogleMap.OnCameraIdleListener onCameraIdleListener)
```
    Adds a callback that's invoked when camera movement has ended.
    Use this method instead of GoogleMap.setOnCameraIdleListener(GoogleMap.OnCameraIdleListener). * MapControl will forward all GoogleMap.OnCameraIdleListener events to the given callback
    
    Parameters:
    
    onCameraIdleListener - The callback that's invoked. To remove the callback, use removeOnCameraIdleListener(GoogleMap.OnCameraIdleListener)
    
    Since:
    
    2.0.0
  - addOnCameraMoveListener
```
public final void addOnCameraMoveListener(com.google.android.gms.maps.GoogleMap.OnCameraMoveListener onCameraMoveListener)
```
    Adds a callback that's invoked repeatedly while the camera is in motion. The callback may be invoked as often as once every frame and should not perform expensive operations.
    Use this method instead of GoogleMap.setOnCameraMoveListener(GoogleMap.OnCameraMoveListener). * MapControl will forward all GoogleMap.OnCameraMoveListener events to the given callback
    
    Parameters:
    
    onCameraMoveListener - The callback that's invoked. To remove the callback, use removeOnCameraMoveListener(GoogleMap.OnCameraMoveListener)
    
    Since:
    
    2.0.0
  - addOnCameraMoveCanceledListener
```
public final void addOnCameraMoveCanceledListener(com.google.android.gms.maps.GoogleMap.OnCameraMoveCanceledListener onCameraMoveCanceledListener)
```
    Adds a callback that's invoked when camera motion is stopped or interrupted by a new type of animation.
    Use this method instead of GoogleMap.setOnCameraMoveCanceledListener(GoogleMap.OnCameraMoveCanceledListener). * MapControl will forward all GoogleMap.OnCameraMoveCanceledListener events to the given callback
    
    Parameters:
    
    onCameraMoveCanceledListener - The callback that's invoked. To remove the callback, use removeOnCameraMoveCanceledListener(GoogleMap.OnCameraMoveCanceledListener)
    
    Since:
    
    2.0.0
  - addOnCameraMoveStartedListener
```
public final void addOnCameraMoveStartedListener(com.google.android.gms.maps.GoogleMap.OnCameraMoveStartedListener onCameraMoveStartedListener)
```
    Adds a callback that's invoked when the camera starts moving or the reason for camera motion has changed.
    Use this method instead of GoogleMap.setOnCameraIdleListener(GoogleMap.OnCameraIdleListener). MapControl will forward all GoogleMap.OnCameraMoveStartedListener events to the given callback
    
    Parameters:
    
    onCameraMoveStartedListener - The callback that's invoked. To remove the callback, use removeOnCameraIdleListener(GoogleMap.OnCameraIdleListener)
    
    Since:
    
    2.0.0
  - removeOnCameraIdleListener
```
public final void removeOnCameraIdleListener(com.google.android.gms.maps.GoogleMap.OnCameraIdleListener onCameraIdleListener)
```
    Removes the callback added with addOnCameraIdleListener(GoogleMap.OnCameraIdleListener)
    
    Parameters:
    
    onCameraIdleListener - The callback added with addOnCameraIdleListener(GoogleMap.OnCameraIdleListener)
    
    Since:
    
    2.0.0
  - removeOnCameraMoveListener
```
public final void removeOnCameraMoveListener(com.google.android.gms.maps.GoogleMap.OnCameraMoveListener onCameraMoveListener)
```
    Removes the callback added with addOnCameraMoveListener(GoogleMap.OnCameraMoveListener)
    
    Parameters:
    
    onCameraMoveListener - The callback added with addOnCameraMoveListener(GoogleMap.OnCameraMoveListener)
    
    Since:
    
    2.0.0
  - removeOnCameraMoveCanceledListener
```
public final void removeOnCameraMoveCanceledListener(com.google.android.gms.maps.GoogleMap.OnCameraMoveCanceledListener onCameraMoveCanceledListener)
```
    Removes the callback added with addOnCameraMoveCanceledListener(GoogleMap.OnCameraMoveCanceledListener)
    
    Parameters:
    
    onCameraMoveCanceledListener - The callback added with addOnCameraMoveCanceledListener(GoogleMap.OnCameraMoveCanceledListener)
    
    Since:
    
    2.0.0
  - removeOnCameraMoveStartedListener
```
public final void removeOnCameraMoveStartedListener(com.google.android.gms.maps.GoogleMap.OnCameraMoveStartedListener onCameraMoveStartedListener)
```
    Removes the callback added with addOnCameraMoveStartedListener(GoogleMap.OnCameraMoveStartedListener)
    
    Parameters:
    
    onCameraMoveStartedListener - The callback added with addOnCameraMoveStartedListener(GoogleMap.OnCameraMoveStartedListener)
    
    Since:
    
    2.0.0
  - setOnCurrentBuildingChangedListener
```
public final void setOnCurrentBuildingChangedListener(OnBuildingFoundAtCameraTargetListener onBuildingFoundAtCameraTargetListener)
```
    Receive notifications when the current building changes
    The current building can be retrieved using getCurrentBuilding()
    
    Parameters:
    
    onBuildingFoundAtCameraTargetListener - Set to null to stop getting
  - setOnCurrentVenueChangedListener
```
public final void setOnCurrentVenueChangedListener(@Nullable
                                                   OnVenueFoundAtCameraTargetListener onVenueFoundAtCameraTargetListener)
```
    Receive notifications when the map camera target enters a Venue (its boundaries)
    
    Parameters:
    
    onVenueFoundAtCameraTargetListener - Set to null to stop getting updates
    
    Since:
    
    3.5.0
  - setOnFloorUpdateListener
```
public final void setOnFloorUpdateListener(OnFloorUpdateListener onFloorUpdateListener)
```
    Set up a listener object to catch floor changes made by either the user or the positioning service
    
    Parameters:
    
    onFloorUpdateListener - Listener object to catch floor changes
  - setOnLocationClusterClickListener
```
public final void setOnLocationClusterClickListener(OnLocationClusterClickListener onLocationClusterClickListener)
```
    Sets the given OnLocationClusterClickListener handler
    
    Parameters:
    
    onLocationClusterClickListener - A custom OnLocationClusterClickListener handler. Set to null to use the default one
    
    Since:
    
    3.0.0
  - setOnLocationSelectedListener
```
public final void setOnLocationSelectedListener(OnLocationSelectedListener onLocationSelectedListener)
```
    Sets a listener for when a location gets selected (programmatically or user-triggered)
    
    Parameters:
    
    onLocationSelectedListener - A callback that will be invoked after a MPLocation has been selected
    
    Since:
    
    3.0.0
  - setOnMapClickListener
```
public final void setOnMapClickListener(OnMapClickListener onMapClickListener)
```
    Set the map click listener. Should be added here instead of GoogleMap.setOnMapClickListener(GoogleMap.OnMapClickListener), because MapControl needs this event.
    IMPORTANT: Please note that, unlike most of the other method callbacks in MapControl, this method doesn't return on the UI Thread
    
    Note that the listener is not GoogleMap.OnMapClickListener but OnMapClickListener instead
    
    Parameters:
    
    onMapClickListener - The map click listener. Set to null to remove it.
    
    Since:
    
    2.0.0
  - setOnMapLongClickListener
```
public final void setOnMapLongClickListener(OnMapLongClickListener onMapLongClickListener)
```
    Sets the long map click listener. Should be set here instead of using GoogleMap.setOnMapLongClickListener(GoogleMap.OnMapLongClickListener)
    
    Parameters:
    
    onMapLongClickListener - The map long click listener. Set to null to remove it.
    
    Since:
    
    3.0.0
  - setOnMarkerClickListener
```
public final void setOnMarkerClickListener(com.google.android.gms.maps.GoogleMap.OnMarkerClickListener onMarkerClickListener)
```
    Set the marker click listener. Should be set here instead of using GoogleMap.setOnMarkerClickListener(GoogleMap.OnMarkerClickListener)
    
    Parameters:
    
    onMarkerClickListener - The marker click listener. Set to null to remove it.
    
    Since:
    
    2.0.0
  - setOnMarkerDragListener
```
public final void setOnMarkerDragListener(com.google.android.gms.maps.GoogleMap.OnMarkerDragListener onMarkerDragListener)
```
    Set the marker drag listener.
    
    Parameters:
    
    onMarkerDragListener - The marker drag listener. Set to null to remove it.
    
    Since:
    
    3.1.1
  - setOnMarkerInfoWindowClickListener
```
public final void setOnMarkerInfoWindowClickListener(com.google.android.gms.maps.GoogleMap.OnInfoWindowClickListener onInfoWindowClickListener)
```
    Set the marker info window click listener. Should be added here instead of GoogleMap.setOnInfoWindowClickListener, because MapControl needs this event.
    
    Parameters:
    
    onInfoWindowClickListener - The marker's info window click listener. Set to null to remove it.
    
    Since:
    
    2.0.0
  - setOnMarkerInfoWindowCloseListener
```
public final void setOnMarkerInfoWindowCloseListener(com.google.android.gms.maps.GoogleMap.OnInfoWindowCloseListener onMarkerInfoWindowCloseListener)
```
    Set the marker info window click listener. Should be added here instead of GoogleMap.setOnInfoWindowCloseListener, because MapControl needs this event.
    
    Parameters:
    
    onMarkerInfoWindowCloseListener - The marker's info window close listener. Set to null to remove it.
    
    Since:
    
    2.0.0
  - setOnMarkerInfoWindowLongClickListener
```
public final void setOnMarkerInfoWindowLongClickListener(com.google.android.gms.maps.GoogleMap.OnInfoWindowLongClickListener onMarkerInfoWindowLongClickListener)
```
    Set the marker info window long click listener. Should be added here instead of GoogleMap.setOnInfoWindowClickListener, because MapControl needs this event.
    
    Parameters:
    
    onMarkerInfoWindowLongClickListener - The marker's info window click listener. Set to null to remove it.
    
    Since:
    
    2.0.3
  - setOnWillUpdateLocationsOnMap
```
public final void setOnWillUpdateLocationsOnMap(OnWillUpdateLocationsOnMap listener)
```
  - setMapLabelFont
```
public void setMapLabelFont(android.graphics.Typeface typeface,
                            int color,
                            boolean showHalo)
```
    Changes the font of the maps marker labels
    
    Parameters:
    
    typeface - The typeface used for a custom font on the label text.
    
    color - The color of the label text.
    
    showHalo - Boolean to decide if the label text should have a white shadow/halo
  - setMapLabelTextSize
```
public void setMapLabelTextSize(int textSize)
```
    Changes the text size of the maps marker labels
    
    Parameters:
    
    textSize - The text size for the label in DP

Class MapControl

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TILE_SIZE_X1

TILE_SIZE_X2

TILE_CACHESCHEME_NONE

TILE_CACHESCHEME_TEMPORARY

TILE_CACHESCHEME_PERSISTENT

TILE_CACHESCHEME_OFFLINE

Constructor Detail

MapControl

Method Detail

init

isReady

clearMap

refreshMap

setGoogleMap

setTileFadeIn

bindToMap

unbindFromMap

setDisplayRule

setDisplayRule

setDisplayRule

setDisplayRule

getDisplayRule

getDisplayRule

getDisplayRules

getDefaultDisplayRule

setDefaultDisplayRule

setDisplayRuleDefaultIconSize

setDisplayRuleDefaultLabelMaxCharLength

addDisplayRule

addDisplayRule

addDisplayRules

addDisplayRules

getDisplayRulesForLocations

resetDisplayRule

resetDisplayRule

getSearchResultCount

getSearchResults

displaySearchResults

displaySearchResults

displaySearchResults

displaySearchResults

displaySearchResults

displaySearchResults

displaySearchResults

displaySearchResults

enableFloorSelector

setFloorSelector

enableClickedPOIHighlight

getClickedPOIHighlightFillColor

getClickedPOIHighlightOutlineStrokeColor

getClickedPOIHighlightOutlineStrokeWidth

getClickedPOIHighlightShowingZoomLevel

setClickedPOIHighlightFillColor

setClickedPOIHighlightOutlineStrokeColor

setClickedPOIHighlightOutlineStrokeWidth

setClickedPOIHighlightShowingZoomLevel

showBuildingOutline

isPOIHighlightEnabled

setInfoWindowAdapter

setLocationClusterImageAdapter

setLocationClusteringEnabled

setLocationHideOnIconOverlapEnabled

setMapPadding

setMapStyle

getMapStyle

getMapStyles

getMapViewPaddingBottom

getMapViewPaddingEnd

getMapViewPaddingStart

getMapViewPaddingTop

setTrackingPositionTiltAngle

showInfoWindowOnClickedLocation

setUserLocationIconFromDisplayRule