WemapCoreSDK/com.getwemap.sdk.core.poi/PointOfInterestManager

PointOfInterestManager

@MainThread

interface PointOfInterestManager

Manages the Points of Interest displayed by the SDK — their visibility, selection, filtering and sorting.

Properties

isUserSelectionEnabled

abstract var isUserSelectionEnabled: Boolean

Indicates whether user interaction for selection is enabled.

selectionMode

abstract var selectionMode: SelectionMode

Determines how POIs can be selected. See SelectionMode for possible values.

selectionUpdates

abstract val selectionUpdates: Flow<PointOfInterestSelectionUpdate>

Emits a snapshot on every change to the set of selected POIs.

touchedPois

abstract val touchedPois: Flow<PointOfInterest>

Emits a POI each time the user touches it (fires regardless of isUserSelectionEnabled).

Functions

addPoi

abstract fun addPoi(poi: PointOfInterest): Boolean

Adds a Point of Interest (POI) to the manager.

addPois

abstract fun addPois(pois: Set<PointOfInterest>): Boolean

Adds multiple Points of Interest (POIs) to the manager.

filterByTag

abstract fun filterByTag(tag: String): Boolean

Filters POIs based on the presence of a specific tag.

filterByTags

abstract fun filterByTags(tags: Collection<String>, matchMode: TagMatchMode = TagMatchMode.OR): Boolean

Filters POIs based on the presence of one or more tags.

getPois

abstract fun getPois(): Set<PointOfInterest>

Retrieves a set of all available Points of Interest (POIs).

getSelectedPoi

abstract fun getSelectedPoi(): PointOfInterest?

Retrieves the currently selected Point of Interest (POI).

getSelectedPois

abstract fun getSelectedPois(): Set<PointOfInterest>

Retrieves the set of currently selected Points of Interest (POIs).

hideAllPois

abstract fun hideAllPois(): Boolean

Hides all Points of Interest (POIs).

hidePoi

abstract fun hidePoi(poi: PointOfInterest): Boolean

Hides a Point of Interest (POI).

abstract fun hidePoi(id: Int): Boolean

Hides the Point of Interest (POI) with the given ID.

hidePois

abstract fun hidePois(pois: Set<PointOfInterest>): Boolean

Hides the specified Points of Interest (POIs).

removeFilters

abstract fun removeFilters(): Boolean

Removes all active filters.

removePoi

abstract fun removePoi(poi: PointOfInterest): Boolean

Removes a Point of Interest (POI) from the manager.

removePois

abstract fun removePois(pois: Set<PointOfInterest>): Boolean

Removes multiple Points of Interest (POIs) from the manager.

showAllPois

abstract fun showAllPois(): Boolean

Shows all Points of Interest (POIs).

showPoi

abstract fun showPoi(poi: PointOfInterest): Boolean

Shows a Point of Interest (POI).

abstract fun showPoi(id: Int): Boolean

Shows the Point of Interest (POI) with the given ID.

showPois

abstract fun showPois(pois: Set<PointOfInterest>): Boolean

Shows a set of Points of Interest (POIs).

sortPoisByDuration

abstract suspend fun sortPoisByDuration(origin: Coordinate, pois: List<PointOfInterest> = getPois().toList()): List<PointOfInterestWithItineraryInfo>

Sorts a list of Points of Interest (POIs) by their estimated travel duration from a given origin.

sortPoisByGraphDistance

abstract suspend fun sortPoisByGraphDistance(origin: Coordinate, pois: List<PointOfInterest> = getPois().toList()): List<PointOfInterestWithItineraryInfo>

Sorts a list of Points of Interest (POIs) by their graph distance from a given origin coordinate.

unselectAllPois

abstract fun unselectAllPois(): Boolean

Unselects all Points of Interest (POIs) currently selected.

unselectPoi

abstract fun unselectPoi(): Boolean

Unselects the currently selected Point of Interest (POI).

abstract fun unselectPoi(poi: PointOfInterest): Boolean

Unselects a Point of Interest (POI).

abstract fun unselectPoi(id: Int): Boolean

Unselects a Point of Interest (POI) with the given ID.