Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetFeaturesParams

Hierarchy

  • GetFeaturesParams

Index

Properties

boundary?: { country?: string; countyIds?: County[]; localityIds?: string[]; rect?: { maxLat: number; maxLon: number; minLat: number; minLon: number } }

Type declaration

  • Optional country?: string
  • Optional countyIds?: County[]
  • Optional localityIds?: string[]
  • Optional rect?: { maxLat: number; maxLon: number; minLat: number; minLon: number }
    • maxLat: number
    • maxLon: number
    • minLat: number
    • minLon: number
boundary.country?: string
deprecated

Use boundary object instead

boundary.county_ids?: string
deprecated

Use boundary object instead

boundary.locality_ids?: string
deprecated

Use boundary object instead

boundary.rect.max_lat?: number
deprecated

Use boundary object instead

boundary.rect.max_lon?: number
deprecated

Use boundary object instead

boundary.rect.min_lat?: number
deprecated

Use boundary object instead

boundary.rect.min_lon?: number
deprecated

Use boundary object instead

focus?: { function?: "linear" | "exp"; scale?: number; weight?: number }

Type declaration

  • Optional function?: "linear" | "exp"

    Which decay function to apply.

    defaultvalue

    linear

  • Optional 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

  • Optional 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

layers?: string[]
limit?: number
multiModal?: "parent" | "child" | "all"
sources?: string[]

Generated using TypeDoc