Area

public struct Area : Hashable

Area to perform search on.

  • Geographic coordinates of the center around which to provide the most relevant places.

    Declaration

    Swift

    public let areaCenter: GeoCoordinates

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

    Declaration

    Swift

    public let boxArea: GeoBox?

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

    Declaration

    Swift

    public let circleArea: GeoCircle?

  • Geographic corridor area in which to provide the most relevant places. The contained polyline and half-width define the area that will be used in a 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.

    When CategoryQuery.Area.corridorArea is provided, CategoryQuery.Area.areaCenter has to be within it, otherwise CategoryQuery.Area.areaCenter is ignored when searching.

    Declaration

    Swift

    public let corridorArea: GeoCorridor?

  • Constructs a new instance of this class from provided parameters.

    Declaration

    Swift

    public init(areaCenter: GeoCoordinates)

    Parameters

    areaCenter

    Geographic coordinates of the center around which to provide the most relevant places.

  • Constructs a new instance of this class from provided parameters.

    Declaration

    Swift

    public init(near areaCenter: GeoCoordinates, inBox boxArea: GeoBox)

    Parameters

    areaCenter

    Geographic coordinates of the center around which to provide the most relevant places.
    boxArea

    Geographic rectangle area in which to provide the most relevant places.

  • Constructs a new instance of this class from provided parameters.

    Declaration

    Swift

    public init(near areaCenter: GeoCoordinates, inCircle circleArea: GeoCircle)

    Parameters

    areaCenter

    Geographic coordinates of the center around which to provide the most relevant places.
    circleArea

    Geographic circle area in which to provide the most relevant places.

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

    Declaration

    Swift

    public init(inCorridor corridorArea: GeoCorridor, near areaCenter: GeoCoordinates)

    Parameters

    corridorArea

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

    Geographic coordinates of the prioritized area center.