91 lines
3.1 KiB
HTML
91 lines
3.1 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Index</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">Index</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3> </h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article><h1>gpx-parse <a href="https://badge.fury.io/js/gpx-parse"><img src="https://badge.fury.io/js/gpx-parse.png" alt="NPM Version"></a> <a href="https://travis-ci.org/elliotstokes/gpx-parse"><img src="https://travis-ci.org/elliotstokes/gpx-parse.png?branch=master" alt="Build Status"></a> <a href="https://coveralls.io/r/elliotstokes/gpx-parse?branch=master"><img src="https://coveralls.io/repos/elliotstokes/gpx-parse/badge.png?branch=master" alt="Coverage Status"></a> <a href="https://codeclimate.com/github/elliotstokes/gpx-parse"><img src="https://codeclimate.com/github/elliotstokes/gpx-parse.png" alt="Code Climate"></a></h1>
|
|
<p>A library for parsing gpx data. Still in its infancy. Works against most/some of the Gpx v1.0 spec and Gpx v1.1. Looking to support whole spec eventually. Feel free to fork if you need something specific.</p>
|
|
<p>More information available on the <a href="http://www.vapidspace.com/gpx-parse">Project Page</a></p>
|
|
<h1>Installation</h1>
|
|
<pre><code>$ npm install gpx-parse</code></pre>
|
|
<h1>Usage</h1>
|
|
<pre><code class="lang-javascript">var gpxParse = require("gpx-parse");
|
|
|
|
//from file
|
|
gpxParse.parseGpxFromFile("/path/to/gpxFile", function(error, data) {
|
|
//do stuff
|
|
});
|
|
|
|
//or from string
|
|
gpxParse.parseGpx("<gpx></gpx>", function(error, data) {
|
|
//do stuff
|
|
});
|
|
|
|
// or an external file via HTTP(S)
|
|
gpxParse.parseRemoteGpxFile("http://host.tld/my.gpx", function(error, data) {
|
|
//do stuff
|
|
});</code></pre>
|
|
<h1>Tests</h1>
|
|
<p>Tests are written with nodeunit. To test make sure you have the dev dependencies installed and just run:</p>
|
|
<pre><code>$ npm test</code></pre></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> |