minimumAroundRadius

Type: integer

Engine default: null

Parameter syntax

'minimumAroundRadius' => radius

minimumAroundRadius: radius

minimumAroundRadius: radius

'minimumAroundRadius': radius

minimumAroundRadius = radius

minimumAroundRadius: Int = radius

.MinimumAroundRadius(radius)

.setMinimumAroundRadius(radius)

opt.MinimumAroundRadius(radius)

aroundPrecision = Some(radius)

Can be used in these methods:
search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, searchForFacetValues, generateSecuredApiKey, addAPIKey, updateAPIKey search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Minimum radius (in meters) used for a geo search when the radius isn’t defined.

When a radius is automatically generated, the area of the circle might be too small to include enough records. This setting allows you to increase the size of the circle, thus ensuring sufficient coverage.

Usage notes

This setting only works within the context of a circular geo search, enabled by aroundLatLng or aroundLatLngViaIP.
This parameter is ignored when aroundRadius is set.

Examples

Set minimum geo search radius

Copy

1
2
3
$results = $index->search('query', [
  'minimumAroundRadius' => 1000 // 1km
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.minimumAroundRadius, to: 1000) // 1km

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Did you find this page helpful?

minimumAroundRadius

About this parameter

Usage notes

Examples

Set minimum geo search radius

On this page