Documentation

geo.totalDistance() function

geo.totalDistance() is experimental and subject to change at any time.

geo.totalDistance() calculates the total distance covered by subsequent points in each input table.

Each row must contain lat (latitude) and lon (longitude) columns that represent the geographic coordinates of the point. Row sort order determines the order in which distance between points is calculated. Use the geo.units option to specify the unit of distance to return (default is km).

Function type signature
(<-tables: stream[{B with lon: float, lat: float}], ?outputColumn: A) => stream[C] where C: Record
For more information, see Function type signatures.

Parameters

outputColumn

Total distance output column. Default is _value.

tables

Input data. Default is piped-forward data (<-).

Examples

Return the total distance travelled per input table

import "experimental/geo"

data
    |> geo.totalDistance()

View example input and output

Return the total distance travelled in miles

import "experimental/geo"

option geo.units = {distance: "mile"}

data
    |> geo.totalDistance()

View example input and output


Was this page helpful?

Thank you for your feedback!


Linux Package Signing Key Rotation

All signed InfluxData Linux packages have been resigned with an updated key. If using Linux, you may need to update your package configuration to continue to download and verify InfluxData software packages.

For more information, see the Linux Package Signing Key Rotation blog post.