offline/com.mapbox.search.offline/OfflineSearchOptions

OfflineSearchOptions

class OfflineSearchOptions @JvmOverloads constructor(val proximity: Point? = null, val limit: Int? = null, val origin: Point? = null, val boundingBox: BoundingBox? = null, val searchPlacesOutsideBoundingBox: Boolean = false, val evSearchOptions: OfflineEvSearchOptions? = null) : Parcelable

Options for the offline search.

See also

Constructors

Link copied to clipboard
@JvmOverloads
fun OfflineSearchOptions(proximity: Point? = null, limit: Int? = null, origin: Point? = null, boundingBox: BoundingBox? = null, searchPlacesOutsideBoundingBox: Boolean = false, evSearchOptions: OfflineEvSearchOptions? = null)

Types

Link copied to clipboard
class Builder

Builder for OfflineSearchOptions instance creation.

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

Link copied to clipboard
val boundingBox: BoundingBox? = null

Limit results to only those contained within the supplied bounding box. The bounding box cannot cross the 180th meridian (longitude +/-180.0 deg.) and North or South pole (latitude +/- 90.0 deg.).

Link copied to clipboard
val evSearchOptions: OfflineEvSearchOptions? = null

Optional offline EV options.

Link copied to clipboard
val limit: Int? = null

Specify the maximum number of results to return.

Link copied to clipboard
val origin: Point? = null

Search origin point, used to calculate the distance to the search result.

Link copied to clipboard
val proximity: Point? = null

Bias the response to favor results that are closer to this location, provided as Point.

Link copied to clipboard
val searchPlacesOutsideBoundingBox: Boolean = false

By default, when boundingBox is applied, all results outside the bounding box are filtered out. If searchPlacesOutsideBoundingBox is set to true, the search for places will be global, meaning results outside the boundingBox will not be filtered out, even if a boundingBox is applied. Default if false.