Highlight and Select

This documentation refers to the introduced concept of select and highlight that was released with SDK 4.3.0

How to change the appearance of different states

The state Display Rules control how Locations in different states are displayed on the map. For example, you can change the icon scale of a Location to highlight it is part of a search result. The state Display Rules give access to the same properties as the regular Display Rules, which can be used to control the appearance of Locations.

The MapsIndoors Android SDK supports Select and Highlight Display Rules and they can be retrieved and edited through MapsIndoors. Example

// Changing the visibility of a polygon for selection
MapsIndoors.getDisplayRule(MPSolutionDisplayRule.SELECTION)?.let {
    it.isPolygonVisible = true
}

// Changing the visibility of a label for highlights
MapsIndoors.getDisplayRule(MPSolutionDisplayRule.HIGHLIGHT)?.let {
    it.isLabelVisible = false
}

Highlight

Highlight is for changing the appearance for a collection of MPLocations, for example to highlight all the restrooms in an office building.

Highlight all Restrooms

// Create a filter to only receive locations with the category Toilet
val filter = MPFilter.Builder().setCategories(Collections.singletonList("Toilet")).build()
// Query locations with the created filter
MapsIndoors.getLocationsAsync(null, filter) { locations, error ->
    if (locations != null) {
        // Highliting all current toilets, with default MPHighlightBehavior. 
        // The MPHighlightBehavior can be used to customize the camera and map behavior,
        // like fitting the view to show all highlighted locations.
        mMapControl?.setHighlight(locations, MPHighlightBehavior.DEFAULT)
    }
}

An example of the highlight solution Display Rule in action

Clear the highlight

mMapControl?.clearHighlight()

Styling the Highlight Badge

The new Highlight Display Rule has a collection of new properties that can be used to change the style of the Highlight badge. You can see all current Display Rule properties in the reference documentation.

Example: Change the color of the Highlight Badge

MapsIndoors.getDisplayRule(MPSolutionDisplayRule.HIGHLIGHT)?.apply {
    badgeFillColor = "#FF0000FF"
    badgeStrokeColor = "FFFF0000"
}
mapControl?.setHighlight(listOf(loc), MPHighlightBehavior.DEFAULT)

Example: Hide the Highlight Badge

MapsIndoors.getDisplayRule(MPSolutionDisplayRule.HIGHLIGHT)?.apply {
    isBadgeVisible = false
}
mapControl?.setHighlight(listOf(loc), MPHighlightBehavior.DEFAULT)

Selection

The selection Display Rule is for changing the appearance of single selected Location, for example when the user clicks on it. To select a Location programmatically, call the method MapControl.selectLocation(location: MPLocation, behavior: MPSelectionBehavior).

mMapControl?.selectLocation(location, MPSelectionBehavior.DEFAULT)

An example of the selection solution DisplayRule in action

Clear current selection

mMapControl?.deSelectLocation()

Styling the Selection Marker

You can easily change the icon to an image of your liking. In this example it is assumed that you have a method getSelectionBitmap() that loads, fetches or generates the image you want to use.

val myBitmap = getSelectionBitmap()
MapsIndoors.getDisplayRule(MPSolutionDisplayRule.SELECTION)?.apply {
    setIcon(myBitmap)
}
mapControl?.selectLocation(loc, MPSelectionBehavior.DEFAULT)

Example of a custom Selection Marker.

Deprecated Selection Highlight

This Selection mechanism is deprecated and will be removed in the next major version of the SDK.

Before the release of 4.3.0 the Android SDK already had a visual implementation of selection with a Display Rule. This is the MPSolutionDisplayRule.SELECTION_HIGHLIGHT that can also be changed like the newly introduced MPSolutionDisplayRule. If you want to retain the old selection rendering, it can be toggled through the Solution Config on the SDK.

Example

MapsIndoors.getSolution()?.config?.isNewSelection = false
MapsIndoors.getDisplayRule(MPSolutionDisplayRule.SELECTION)?.apply {
    polygonFillColor = "FF0000FF"
    polygonFillOpacity = 0.2f
    polygonStrokeWidth = 2.0f
    polygonStrokeColor = "FF0000FF"
    isPolygonVisible = true
    isIconVisible = false
}
mapControl?.selectLocation(loc, MPSelectionBehavior.DEFAULT)

Note that the isNewSelection setting lives on the Solution, so with any subsequent load of MapsIndoors it will be necessary to set the value to false again, as it defaults to true.