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 iOS SDK supports Select and Highlight Display Rules and they can be retrieved and edited through MPMapsIndoors.shared.

Example

// Changing the visibility of a polygon for selection
if let displayRule = MPMapsIndoors.shared.displayRuleFor(displayRuleType: .selection) {
    displayRule.polygonVisible = true
}

​// Changing the visibility of a label for highlights
if let displayRule = MPMapsIndoors.shared.displayRuleFor(displayRuleType: .highlight) {
    displayRule.labelVisible = 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
let filter =  MPFilter()
filter.categories = ["Toilet"]

// Query locations with the created filter
let locations = await MPMapsIndoors.shared.locationsWith(query: nil, filter: filter)

// Highlighting all current toilets, with the default MPHighlightBehavior.
// The MPHighlightBehavior can be used to customize the camera and map behavior,
// like fitting the view to show all highlighted locations.
mapControl?.setHighlight(locations: locations, behavior: .default)

An example of the highlight solution Display Rule in action

Clear the highlight

mapControl?.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

if let highlightRule = MPMapsIndoors.shared.displayRuleFor(displayRuleType: .highlight) {
    highlightRule.badgeFillColor = .blue
    highlightRule.badgeStrokeColor = .red
}
mapControl?.setHighlight(locations: [loc], behavior: .default)

Example: Hide the Highlight Badge

if let highlightRule = MPMapsIndoors.shared.displayRuleFor(displayRuleType: .highlight) {
    highlightRule.badgeVisible = false
}
mapControl?.setHighlight(locations: [loc], behavior: .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 MPMapControl.select(location:behavior)

mapControl?.select(location: location, behavior: .default)

An example of the selection solution DisplayRule in action

Clear current Selection

mapControl?.select(location: nil, behavior: .default)

Styling the Selection Marker

You can easily change the icon to an image from your app Asset Catalogue. In this example it is assumed that you have an image in the project Asset Catalogue named selectionIcon:

if let selectionRule = MPMapsIndoors.shared.displayRuleFor(displayRuleType: .selection) {
    selectionRule.icon = UIImage(named: "selectionIcon")
}
mapControl?.select(location: loc, behavior: .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 MapsIndoors SDK already had a visual implementation of selection with a Display Rule. That Display Rule can also be changed like the newly introduced Selection Display Rule. If you want to retain the old selection rendering, it can be toggled through the Solution Config on the SDK.

Example

MPMapsIndoors.shared.solution?.config.newSelection = false
let selectionRule = MPMapsIndoors.shared.displayRuleFor(displayRuleType: .selectionHighlight)
selectionRule?.polygonFillColor = .blue
selectionRule?.polygonFillOpacity = 0.2
selectionRule?.polygonStrokeWidth = 2.0
selectionRule?.polygonStrokeColor = .blue
selectionRule?.polygonVisible = true
selectionRule?.iconVisible = false

Note that the newSelection 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.