Options
All
  • Public
  • Public/Protected
  • All
Menu

To focus your search based upon a geographical area, such as the center of the user's map or at the device's GPS location, supply the parameters focus.point.lat and focus.point.lon. This boosts locally relevant results higher.

Hierarchy

  • Focus

Index

Properties

function?: "linear" | "exp"

Which decay function to apply.

defaultvalue

linear

point: { lat: number; lon: number }

Type declaration

  • lat: number
  • lon: number
scale?: number

Controls the rate of decay, i.e. at which distance in km from the given location the scoring will be given the boost factor of the default decay value, which is 0.5.

defaultvalue

2500

weight?: number

Base weight to be applied to boosting results based on location. This value will be multiplied by a factor determined by decay function and scale.

defaultvalue

15

Generated using TypeDoc