401 lines
5.8 KiB
HTML
401 lines
5.8 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<title>JSDoc: Module: geomutils</title>
|
||
|
|
|
||
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
||
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
||
|
|
<!--[if lt IE 9]>
|
||
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||
|
|
<![endif]-->
|
||
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<div id="main">
|
||
|
|
|
||
|
|
<h1 class="page-title">Module: geomutils</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
|
||
|
|
<header>
|
||
|
|
<h2>
|
||
|
|
geomutils
|
||
|
|
</h2>
|
||
|
|
|
||
|
|
</header>
|
||
|
|
|
||
|
|
<article>
|
||
|
|
<div class="container-overview">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="geomUtils.js.html">geomUtils.js</a>, <a href="geomUtils.js.html#line1">line 1</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3 class="subsection-title">Methods</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
|
||
|
|
<dt>
|
||
|
|
<h4 class="name" id="calculateDistance"><span class="type-signature"><static> </span>calculateDistance<span class="signature">(lat1, lon1, lat2, lon2)</span><span class="type-signature"> → {number}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
</dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
Calculates the distance between the two points using the haversine method.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>lat1</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type">number</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">The latitude of the first point.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>lon1</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type">number</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">The longtitude of the first point.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>lat2</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type">number</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">The latitude of the first point.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>lon2</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type">number</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">The longtitude of the first point.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="geomUtils.js.html">geomUtils.js</a>, <a href="geomUtils.js.html#line26">line 26</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Returns:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
The distance in miles between the two points.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt>
|
||
|
|
Type
|
||
|
|
</dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<span class="param-type">number</span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt>
|
||
|
|
<h4 class="name" id="calculateMidpoint"><span class="type-signature"><static> </span>calculateMidpoint<span class="signature">()</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
</dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
Calcuates the midpoint between the two points passed in.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="geomUtils.js.html">geomUtils.js</a>, <a href="geomUtils.js.html#line42">line 42</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</article>
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav>
|
||
|
|
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-geomutils.html">geomutils</a></li><li><a href="module-gpx-parse.html">gpx-parse</a></li></ul><h3>Classes</h3><ul><li><a href="GpxExtent.html">GpxExtent</a></li><li><a href="GpxMetaData.html">GpxMetaData</a></li><li><a href="GpxResult.html">GpxResult</a></li><li><a href="GpxRoute.html">GpxRoute</a></li><li><a href="GpxTrack.html">GpxTrack</a></li><li><a href="GpxWaypoint.html">GpxWaypoint</a></li></ul><h3><a href="global.html">Global</a></h3>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<br clear="both">
|
||
|
|
|
||
|
|
<footer>
|
||
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Wed Aug 13 2014 09:19:33 GMT+0100 (BST)
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
<script> prettyPrint(); </script>
|
||
|
|
<script src="scripts/linenumber.js"> </script>
|
||
|
|
</body>
|
||
|
|
</html>
|