Function calcDistance

calcDistance(
    feature: GeoJSONStoreFeatures,
    unitType: MeasureUnitType,
    distancePrecision: number,
    forceUnit?: distanceUnitType,
    measureUnitSymbols?: MeasureUnitSymbolType,
    map?: Map$1,
    computeElevation?: boolean,
    terrainSource?: TerrainSource,
): GeoJSONStoreFeatures
Caclulate distance for each segment on a given feature
Parameters
- feature: GeoJSONStoreFeatures
  LineString GeoJSON feature
- unitType: MeasureUnitType
  measure unit type either metric or imperial
- distancePrecision: number
  Precision of distance
- OptionalforceUnit: distanceUnitType
  Default is auto. If auto is set, unit is converted depending on the value in metric.
- OptionalmeasureUnitSymbols: MeasureUnitSymbolType
  Optional parameter to provide custom unit symbols
- Optionalmap: Map$1
  Maplibre map instance
- OptionalcomputeElevation: boolean
  Compute elevation for each segment
- OptionalterrainSource: TerrainSource
  Terrain source for elevation calculation. If terrainSource is undefined, going to to query elevation from maplibre terrain.
Returns GeoJSONStoreFeatures
The returning feature will contain segments, distance, unit properties. segments will have multiple point features.
- Defined in helpers/calcDistance.ts:24