Get Started Contact sales

GooglePlacesSwift Framework Reference

  • CircularCoordinateRegion defines a circular area on the Earth's surface using a center point and radius.

  • It is an immutable structure with properties for center coordinates and radius in meters.

  • This struct conforms to protocols for coordinate region, bias, restriction, equatable, and hashable functionalities.

  • It provides methods for generating bias and restriction URLQueryItem instances.

  • You can create a CircularCoordinateRegion using a center coordinate and radius.

CircularCoordinateRegion

struct CircularCoordinateRegion
 
extension CircularCoordinateRegion : CoordinateRegion, CoordinateRegionBias, CoordinateRegionRestriction, Copyable, Equatable, Escapable, Hashable, Sendable

CircularCoordinateRegion represents a circular bounding region on the Earth’s surface. CircularCoordinateRegion is immutable and can’t be modified after construction.

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (lhs: CircularCoordinateRegion, rhs: CircularCoordinateRegion) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Returns the region bias as URLQueryItem.

    Declaration

    Swift

    func bias() -> URLQueryItem

  • Represents the center of the circle, specified by its latitude-longitude coordinates.

    Declaration

    Swift

    var center: CLLocationCoordinate2D { get }

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)

  • The hash value.

    Hash values are not guaranteed to be equal across different executions of your program. Do not save hash values to use during a future execution.

    Important

    hashValue is deprecated as a Hashable requirement. To conform to Hashable, implement the hash(into:) requirement instead. The compiler provides an implementation for hashValue for you.

    Declaration

    Swift

    var hashValue: Int { get }

  • Inits the center coordinates and radius corresponding to the rectangular region defined by the two corners.

    Declaration

    Swift

    init(center: CLLocationCoordinate2D, radius: CLLocationDistance)

    Parameters

    center

    The center of this region.
    radius

    The radius of this region.

  • Represents the sradius of the circle, measured in meters.

    Declaration

    Swift

    var radius: CLLocationDistance { get }

  • Returns the region restriction as URLQueryItem.

    Declaration

    Swift

    func restriction() -> URLQueryItem