navigation-ux-ev-core/com.mapbox.ev.core.search.support/EvSearchOptions/Builder

Builder

class Builder(resultLimit: Int = DEFAULT_RESULT_LIMIT, searchRadius: Double = DEFAULT_EV_STATION_SEARCH_RADIUS_KM, evSearchResultRankings: MutableList<EvSearchResultRanking> = mutableListOf(), evSearchResultFilters: MutableList<EvSearchFilter> = mutableListOf(), targetPointForSearchSorting: Point? = null)

Constructors

Builder

constructor(resultLimit: Int = DEFAULT_RESULT_LIMIT, searchRadius: Double = DEFAULT_EV_STATION_SEARCH_RADIUS_KM, evSearchResultRankings: MutableList<EvSearchResultRanking> = mutableListOf(), evSearchResultFilters: MutableList<EvSearchFilter> = mutableListOf(), targetPointForSearchSorting: Point? = null)

Functions

build

fun build(): EvSearchOptions

clearSearchResultRankings

fun clearSearchResultRankings(): EvSearchOptions.Builder

withResultLimit

fun withResultLimit(limit: Int): EvSearchOptions.Builder

withSearchRadius

fun withSearchRadius(radius: Double): EvSearchOptions.Builder

withSearchResultFilter

fun withSearchResultFilter(filter: EvSearchFilter): EvSearchOptions.Builder

withSearchResultRanking

fun withSearchResultRanking(ranking: EvSearchResultRanking): EvSearchOptions.Builder

withSearchResultRankingTopPriority

fun withSearchResultRankingTopPriority(ranking: EvSearchResultRanking): EvSearchOptions.Builder

Adds a search ranking to the first position in the rankings collection. Order matters, the rankings are processed from the first in the collection to the last.

withTargetPointForSearchSorting

fun withTargetPointForSearchSorting(target: Point): EvSearchOptions.Builder

If provided the search results will be sorted by the distance from the target point in ascending order.