GeographyPoint

open class GeographyPoint : GeographyValue, @unchecked Sendable

A geography point.

  • Constructor

    Declaration

    Swift

    override public init()

  • The coordinates of this value.

    Declaration

    Swift

    public final var coordinates: PointCoordinates { get set }

  • Declaration

    Swift

    override open func copyMutable() -> DataValue

    Return Value

    A clone of this value if it (together with all value subcomponents) is possibly mutable, or return self value if it (together with all value subcomponents) is definitely immutable. The resulting value might share mutable metadata with this query.

  • Data type of the wrapped value.

    Declaration

    Swift

    override open var dataType: DataType { get }

  • See also

    https://en.wikipedia.org/wiki/Well-known_text, OData ABNF.

    Declaration

    Swift

    override open func formatWKT(sridRequired: Bool = false) -> String

    Parameters

    sridRequired

    Is SRID prefix required?

    Return Value

    This value formatted in OData WKT (well-known text) format.

  • Declaration

    Swift

    open class func parse(_ text: String) throws -> GeographyPoint

    Parameters

    text

    A value in GeoJSON format.

    Return Value

    A value parsed from text in GeoJSON format.

  • See also

    https://en.wikipedia.org/wiki/Well-known_text, OData ABNF.

    Declaration

    Swift

    open class func parseWKT(_ text: String, sridRequired: Bool = false) throws -> GeographyPoint

    Parameters

    text

    A value in OData WKT format.
    sridRequired

    Is SRID prefix required?

    Return Value

    A value parsed from OData WKT (well-known text) format.

  • Declaration

    Swift

    open class func with(x: Double, y: Double) -> GeographyPoint

    Parameters

    x

    X-coordinate (longitude).
    y

    Y-coordinate (latitude).

    Return Value

    2D geography point.

  • Declaration

    Swift

    open class func with(x: Double, y: Double, m: Double) -> GeographyPoint

    Parameters

    x

    X-coordinate (longitude).
    y

    Y-coordinate (latitude).
    m

    M-coordinate (measure).

    Return Value

    2D geography point with measure.

  • Declaration

    Swift

    open class func with(x: Double, y: Double, z: Double) -> GeographyPoint

    Parameters

    x

    X-coordinate (longitude).
    y

    Y-coordinate (latitude).
    z

    Z-coordinate (altitude).

    Return Value

    3D geography point.

  • Declaration

    Swift

    open class func with(x: Double, y: Double, z: Double, m: Double) -> GeographyPoint

    Parameters

    x

    X-coordinate (longitude).
    y

    Y-coordinate (latitude).
    z

    Z-coordinate (altitude).
    m

    M-coordinate (measure).

    Return Value

    3D geography point with measure.

  • Declaration

    Swift

    open class func with(latitude: Double, longitude: Double) -> GeographyPoint

    Parameters

    latitude

    Y-coordinate.
    longitude

    X-coordinate.

    Return Value

    2D geography point.