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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val descending: Option[Boolean]
- Definition Classes
- GeoDistanceSort → SearchSort
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val field: String
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def identifier: String
The identifier for the sort type, used in the "by" field.
The identifier for the sort type, used in the "by" field.
- Attributes
- protected
- Definition Classes
- GeoDistanceSort → SearchSort
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val location: Seq[Float]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def unit(unit: String): GeoDistanceSort
- val unit: Option[String]
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()