Options
All
  • Public
  • Public/Protected
  • All
Menu

Utility functions for computing geodesic angles, distances and areas. The default radius is Earth's radius of 6378137 meters.

Index

Functions

computeArea

  • Returns the area of a closed path. The computed area uses the same units as the radius. The radius defaults to the Earth's radius in meters, in which case the area is in square meters.

    Parameters

    Returns number

computeDistanceBetween

  • computeDistanceBetween(from: LatLng, to: LatLng, radius?: number): number
  • Returns the distance, in meters, between two LatLngs. You can optionally specify a custom radius. The radius defaults to the radius of the Earth.

    Parameters

    Returns number

computeHeading

  • Returns the heading from one LatLng to another LatLng. Headings are expressed in degrees clockwise from North within the range [-180,180).

    Parameters

    Returns number

computeLength

  • Returns the length of the given path.

    Parameters

    Returns number

computeOffset

  • computeOffset(from: LatLng, distance: number, heading: number, radius?: number): LatLng
  • Returns the LatLng resulting from moving a distance from an origin in the specified heading (expressed in degrees clockwise from north).

    Parameters

    • from: LatLng
    • distance: number
    • heading: number
    • Optional radius: number

    Returns LatLng

computeOffsetOrigin

  • computeOffsetOrigin(to: LatLng, distance: number, heading: number, radius?: number): LatLng
  • Returns the location of origin when provided with a LatLng destination, meters travelled and original heading. Headings are expressed in degrees clockwise from North. This function returns null when no solution is available.

    Parameters

    • to: LatLng
    • distance: number
    • heading: number
    • Optional radius: number

    Returns LatLng

computeSignedArea

  • Returns the signed area of a closed path. The signed area may be used to determine the orientation of the path. The computed area uses the same units as the radius. The radius defaults to the Earth's radius in meters, in which case the area is in square meters.

    Parameters

    Returns number

interpolate

  • Returns the LatLng which lies the given fraction of the way between the origin LatLng and the destination LatLng.

    Parameters

    Returns LatLng

Generated using TypeDoc