Class GeoDistanceSearchSort

Provides sorting for a search query by geographic distance from a point.

Hierarchy (View Summary)

SearchSort
- GeoDistanceSearchSort

Index

Properties

Methods

descending toJSON unit field geoDistance id score

Properties

`Protected`_data

_data: any

Methods

descending

descending(descending: boolean): GeoDistanceSearchSort
Parameters
- descending: boolean
Returns GeoDistanceSearchSort
- Defined in lib/searchsort.ts:145

toJSON

toJSON(): any
Returns any
Inherited from SearchSort.toJSON
- Defined in lib/searchsort.ts:19

unit

unit(unit: string): GeoDistanceSearchSort
Parameters
- unit: string
Returns GeoDistanceSearchSort
- Defined in lib/searchsort.ts:140

`Static`field

field(field: string): FieldSearchSort
Parameters
- field: string
Returns FieldSearchSort
Inherited from SearchSort.field
- Defined in lib/searchsort.ts:31

`Static`geoDistance

geoDistance(field: string, lat: number, lon: number): GeoDistanceSearchSort
Parameters
- field: string
- lat: number
- lon: number
Returns GeoDistanceSearchSort
Inherited from SearchSort.geoDistance
- Defined in lib/searchsort.ts:35

`Static`id

id(): IdSearchSort
Returns IdSearchSort
Inherited from SearchSort.id
- Defined in lib/searchsort.ts:27

`Static`score

score(): ScoreSearchSort
Returns ScoreSearchSort
Inherited from SearchSort.score
- Defined in lib/searchsort.ts:23