CategoryQueryArea.withCorridorAndCenter constructor

CategoryQueryArea.withCorridorAndCenter(
  1. GeoCorridor corridorArea,
  2. GeoCoordinates areaCenter
)

Constructs a new instance of this class from provided parameters.

The given corridor and center define the area that will be used in the search query.

When used with SearchEngine, the polyline is compressed and sent. More complex polylines with large amounts of coordinates and with smaller half-width may have the less relevant part removed, such as the one far away from the search center. This usually makes no difference, because there will be enough POIs near the search center. For use cases where it is important to search the entire polyline, half-width can be increased or not set. For example: Route between New York and Chicago with half-width 800 will be added to request without removing the far away part, but route of the same length (around 360km) between Milan (Italy) and Konstanz (Germany) will have the far away part removed due to its complexity.

The area center has to be within the corridor, otherwise it is ignored.

  • corridorArea Geographic corridor area in which to provide the most relevant places.

  • areaCenter Geographic coordinates of the prioritized area center.

Implementation

factory CategoryQueryArea.withCorridorAndCenter(GeoCorridor corridorArea, GeoCoordinates areaCenter) => $prototype.withCorridorAndCenter(corridorArea, areaCenter);