case class GeoDistanceSort(location: Seq[Float], field: String, descending: Option[Boolean] = None, unit: Option[String] = None) extends SearchSort with Product with Serializable
Sort by a geo location distance.
- location
should be a two-value Seq containing the longitude and latitude (in that order) to centre the search on
- field
the name of the field to sort on
- descending
whether the search results should be sorted in descending order. If None (the default) is specified, it is left to the server (which sorts descending by default)
- unit
the unit multipler to use for sorting. Acceptable values are: "inch", "yards", "feet", "kilometers", "nauticalmiles", "millimeters", "centimeters", "miles" and "meters". Standard abbreviations for those ("ft", "km", "mi") may also be used. If left at default
None, it defaults on the server side to "meters".
- Since
1.0.0
- Alphabetic
- By Inheritance
- GeoDistanceSort
- Serializable
- Product
- Equals
- SearchSort
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new GeoDistanceSort(location: Seq[Float], field: String, descending: Option[Boolean] = None, unit: Option[String] = None)
- location
should be a two-value Seq containing the longitude and latitude (in that order) to centre the search on
- field
the name of the field to sort on
- descending
whether the search results should be sorted in descending order. If None (the default) is specified, it is left to the server (which sorts descending by default)
- unit
the unit multipler to use for sorting. Acceptable values are: "inch", "yards", "feet", "kilometers", "nauticalmiles", "millimeters", "centimeters", "miles" and "meters". Standard abbreviations for those ("ft", "km", "mi") may also be used. If left at default
None, it defaults on the server side to "meters".
Value Members
- val descending: Option[Boolean]
- Definition Classes
- GeoDistanceSort → SearchSort
- val field: String
- def injectParams(queryJson: JsonObject): Unit
- Definition Classes
- GeoDistanceSort → SearchSort
- val location: Seq[Float]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def productIterator: Iterator[Any]
- Definition Classes
- Product
- def unit(unit: String): GeoDistanceSort
- val unit: Option[String]