GeoFilter

Version:


Type	Class
Extends	`BaseFilter`
Import path	`@sitecore-cloudsdk/search/browser`

A filter that returns search results depending on geographical data, such as the radius of a circular geographical area.

For example, return search results only for those products that are available for purchase within "16km" of where the search request was made.

Constructor

GeoFilter(
  attributeName: string,
  geoFilterData: GeoFilterData
)

Name	Type	Description
`attributeName`	`string`	The entity's attribute to match against the geographical data. Example: `"location"`
`geoFilterData`	`GeoFilterData`	Geographical data used for filtering search results.

Name	Type	Description
`_attributeName`	`string`	Required. The entity's attribute to match against the geographical data.

Validates latitude and longitude.

private _validateLocation(location: LocationData): void

Name	Type	Description
`location`	`LocationData`	The geographical coordinates of the location that the site visitor wants to see search results for. Overrides the site visitor's current location (`geoData.location`).

Returns void.

Maps the GeoFilter instance to its DTO (data transfer object) format.

toDTO(): GeoFilterDTO

Returns the GeoFilter instance in a standardized DTO format.

If you have suggestions for improving this article, let us know!