# @turf/directional-mean

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

## DirectionalMeanLine

Type: [Object][1]

### Properties

*   `cartesianAngle` **[number][2]** the mean angle of all lines. (measure from due earth counterclockwise).
*   `bearingAngle` **[number][2]** the mean angle of all lines. (bearing).
*   `circularVariance` **[number][2]** the extent to which features all point in the same direction.
    the value ranges 0-1, the bigger the value, the more variation in directions between lines.
*   `averageX` **[number][2]** the centroid of all lines.
*   `averageY` **[number][2]** the centroid of all line.
*   `averageLength` **[number][2]** the average length of line.
*   `countOfLines` **[number][2]** the count of features.

## directionalMean

This module calculate the average angle of a set of lines, measuring the trend of it.
It can be used in both project coordinate system and geography coordinate system.
It can handle segments of line or the whole line.

### Parameters

*   `lines` **[FeatureCollection][3]<[LineString][4]>**&#x20;
*   `options` **[object][1]**  (optional, default `{}`)

    *   `options.planar` **[boolean][5]** whether the spatial reference system is projected or geographical. (optional, default `true`)
    *   `options.segment` **[boolean][5]** whether treat a LineString as a whole or a set of segments. (optional, default `false`)

### Examples

```javascript
var lines = turf.lineStrings([
  [[110, 45], [120, 50]],
  [[100, 50], [115, 55]],
])
var directionalMeanLine = turf.directionalMean(lines);
// => directionalMeanLine
```

Returns **[DirectionalMeanLine][6]** Directional Mean Line

[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

[3]: https://tools.ietf.org/html/rfc7946#section-3.3

[4]: https://tools.ietf.org/html/rfc7946#section-3.1.4

[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean

[6]: #directionalmeanline

<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->

---

This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.

### Installation

Install this single module individually:

```sh
$ npm install @turf/directional-mean
```

Or install the all-encompassing @turf/turf module that includes all modules as functions:

```sh
$ npm install @turf/turf
```
