turf/io.github.elcolto.geokjson.turf

Package-level declarations

Types

ExperimentalTurfApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class ExperimentalTurfApi

Units

enum Units : Enum<Units>

Supported units of measurement in Turf.

Properties

AREA_EARTH_RADIUS

const val AREA_EARTH_RADIUS: Int = 6378137

EARTH_RADIUS

const val EARTH_RADIUS: Double = 6371008.8

Radius of the Earth used with the Harvesine formula. Approximated using a spherical (non-ellipsoid) Earth.

Functions

bearingToAzimuth

fun bearingToAzimuth(bearing: Double): Double

Converts any bearing angle from the north line direction (positive clockwise) and returns an angle between 0-360 degrees (positive clockwise), 0 being the north line

convertArea

fun convertArea(area: Double, from: Units = Units.Meters, to: Units = Units.Kilometers): Double

Converts an area to the requested unit. Valid units: Acres, Miles, Inches, Yards, Meters, Kilometers, Centimeters, Feet

convertLength

fun convertLength(length: Double, from: Units = Units.Meters, to: Units = Units.Kilometers): Double

Converts a length to the requested unit

coordAll

fun FeatureCollection.coordAll(): List<Position>

fun Feature<*>.coordAll(): List<Position>?

fun Geometry.coordAll(): List<Position>

lengthToDegrees

fun lengthToDegrees(distance: Double, units: Units = Units.Kilometers): Double

Convert a distance measurement (assuming a spherical Earth) from a real-world unit into degrees.

lengthToRadians

fun lengthToRadians(distance: Double, units: Units = Units.Kilometers): Double

Convert a distance measurement (assuming a spherical Earth) from a real-world unit into radians.

radiansToLength

fun radiansToLength(radians: Double, units: Units = Units.Kilometers): Double

Convert a distance measurement (assuming a spherical Earth) from radians to a more friendly unit.