compass-geocoder-web-mapbox/dev.jordond.compass.geocoder.web.parameter

Package-level declarations

Types

Link copied to clipboard
class MapboxBoundingBox(val minLongitude: Double, val minLatitude: Double, val maxLongitude: Double, val maxLatitude: Double) : QueryParamValue

A bounding box to limit search results to a specific area.

Link copied to clipboard
class MapboxParameters(val permanent: Boolean = false, val autocomplete: Boolean = true, val limit: Int? = null, val bbox: MapboxBoundingBox? = null, val country: String? = null, val language: String? = null, val proximity: String? = null, val types: MapboxTypesList? = null, val worldView: MapboxWorldView? = null) : QueryParameters

Options for the Mapbox geocoder.

Link copied to clipboard
Link copied to clipboard
enum MapboxTypes : Enum<MapboxTypes> , QueryParamValue

The types of features that can be returned by the Mapbox Geocoding API.

Link copied to clipboard
class MapboxTypesList(val values: List<MapboxTypes>) : QueryParamListValue<MapboxTypes>

A list of MapboxTypes to be used as a query parameter.

Link copied to clipboard
enum MapboxWorldView : Enum<MapboxWorldView> , QueryParamValue

The world view parameter is used to filter the results to a specific country or region.

Functions

Link copied to clipboard
fun mapboxParameters(block: MapboxParametersBuilder.() -> Unit): MapboxParameters

Create a MapboxParameters instance with the provided block.