npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@we-gold/gpxjs

v1.0.13

Published

GPX.js is a modern library for parsing GPX files and converting them to GeoJSON.

Downloads

689

Readme

GitHub package.json version (branch) npm bundle size contributions welcome ViewCount License: MIT NPM Downloads

GPX.JS

Based on GPXParser.js, which has been unmaintained, this updated library is intended to bring modern JavaScript features to GPX parsing, including extensions in tracks and fully featured typescript support.

I'm also open to any improvements or suggestions with the library, so feel free to leave an issue (Contributing).

GPX Schema

The schema for GPX, a commonly used gps tracking format, can be found here: GPX 1.1.

See Documentation for more details on how GPX data is represented by the library.

Usage

This library does include support for non-browser execution.

Right now, to use this in Node.js without a browser or in something like React Native, use xmldom-qsa instead.

See instructions below on how to use a custom DOM parser.

Install using NPM

npm i @we-gold/gpxjs

Then, import the parseGPX method:

import { parseGPX } from "@we-gold/gpxjs"

const [parsedFile, error] = parseGPX(myXMLGPXString)

// Or use a try catch to verify
if (error) throw error

const geojson = parsedFile.toGeoJSON()

Include JavaScript File

In an HTML document:

<script src="./src/gpxjs.js"></script>

<script type="module">
	import { parseGPX } from "@we-gold/gpxjs"

	const [parsedFile, error] = parseGPX(myXMLGPXString)

	// Or use a try catch to verify
	if (error) throw error

	const geojson = parsedFile.toGeoJSON()
</script>

Fetching a GPX File

While this feature isn't included, it is fairly simple to fetch a GPX file and format it as a string.

import { parseGPX } from "@we-gold/gpxjs"

fetch("./somefile.gpx")
	.then((response) => {
		if (!response.ok) {
			throw new Error("Failed to fetch the file")
		}
		return response.text()
	})
	.then((data) => {
		const [parsedFile, error] = parseGPX(data)

		// Or use a try catch to verify
		if (error) throw error

		const geojson = parsedFile.toGeoJSON()
	})

parseGPX has an additional optional argument removeEmptyFields which removes empty or null values from the output. It is true by default. This argument is also available in parseGPXWithCustomParser.

Use the Parsed GPX

const totalDistance = gpx.tracks[0].distance.total

const extensions = gpx.tracks[1].extensions

Export to GeoJSON

const geoJSON = parsedGPX.toGeoJSON()

Export to GPX

import { stringifyGPX } from "@we-gold/gpxjs"

const xmlAsString = stringifyGPX(parsedGPX);

Using a Custom DOM Parser

If working in an environment where a custom DOM Parser is required, you can include it like so:

Note, this is significantly slower than using the browser parser.

import { parseGPXWithCustomParser, stringifyGPX} from "@we-gold/gpxjs"
import { DOMParser, XMLSerializer } from "xmldom-qsa"

const customParseMethod = (txt: string): Document | null => {
	return new DOMParser().parseFromString(txt, "text/xml")
}

const [parsedFile, error] = parseGPXWithCustomParser(
	myXMLGPXString,
	customParseMethod
)

const xml = stringifyGPX(parsedFile, new XMLSerializer());

Contribution

If you are having an issue and aren't sure how to resolve it, feel free to leave an issue.

If you do know how to fix it, please leave a PR, as I cannot guarantee how soon I can address the issue myself.

I do try to be responsive to PRs though, so if you leave one I'll try to get it merged asap.

Also, there are some basic tests built in to the library, so please test your code before you try to get it merged (just to make sure everything is backwards compatible). Use npm run test to do this.

Options

You can also run parseGPX() with custom options for more control over the parsing process. See options.ts for more details.

const [parsedFile, error] = parseGPX(data, {
    avgSpeedThreshold: 0.1,
})
// same for parseGPXWithCustomParser()

| Property | Type | Description | | ----------------- | ------- | ----------------------------------------------------------------------- | | removeEmptyFields | boolean | delete null fields in output | | avgSpeedThreshold | number | average speed threshold (in m/ms) used to determine the moving duration |

Types

These descriptions are adapted from GPXParser.js, with minor modifications.

For specific type definition, see types.ts.

| Property | Type | Description | | --------- | ------------------ | ----------------------------------- | | xml | XML Document | XML Document parsed from GPX string | | metadata | Metadata object | File metadata | | waypoints | Array of Waypoints | Array of waypoints | | tracks | Array of Tracks | Array of waypoints of tracks | | routes | Array of Routes | Array of waypoints of routes |

Metadata

| Property | Type | Description | | ----------- | ----------- | ------------- | | name | String | File name | | description | String | Description | | link | Link object | Web address | | author | Float | Author object | | time | String | Time |

Waypoint

| Property | Type | Description | | ----------- | ------ | ----------------- | | name | String | Point name | | comment | String | Comment | | description | String | Point description | | latitude | Float | Point latitute | | longitude | Float | Point longitude | | elevation | Float | Point elevation | | time | Date | Point time |

Track

| Property | Type | Description | | ----------- | ---------------- | ------------------------------------- | | name | String | Point name | | comment | String | Comment | | description | String | Point description | | src | String | Source device | | number | String | Track identifier | | link | String | Link to a web address | | type | String | Track type | | points | Array | Array of Points | | distance | Distance Object | Distance information about the Track | | duration | Duration Object | Duration information about the Track | | elevation | Elevation Object | Elevation information about the Track | | slopes | Float Array | Slope of each sub-segment |

Route

| Property | Type | Description | | ----------- | ---------------- | ------------------------------------- | | name | String | Point name | | comment | String | Comment | | description | String | Point description | | src | String | Source device | | number | String | Track identifier | | link | String | Link to a web address | | type | String | Route type | | points | Array | Array of Points | | distance | Distance Object | Distance information about the Route | | duration | Duration Object | Duration information about the Route | | elevation | Elevation Object | Elevation information about the Route | | slopes | Float Array | Slope of each sub-segment |

Point

| Property | Type | Description | | --------- | ----- | --------------- | | latitude | Float | Point latitute | | longitude | Float | Point longitude | | elevation | Float | Point elevation | | time | Date | Point time |

Distance

| Property | Type | Description | | ---------- | ----- | ---------------------------------------------------- | | total | Float | Total distance of the Route/Track | | cumulative | Float | Cumulative distance at each point of the Route/Track |

Duration

| Property | Type | Description | | -------------- | ------------ | ---------------------------------------------------- | | cumulative | Float | Cumulative duration at each point of the Route/Track | | movingDuration | Float | Total moving duration of the Route/Track in seconds | | totalDuration | Float | Total duration of the Route/Track in seconds | | startTime | Date or null | Start date, if available | | endTime | Date or null | End date, if available |

Elevation

| Property | Type | Description | | -------- | ----- | ----------------------------- | | maximum | Float | Maximum elevation | | minimum | Float | Minimum elevation | | positive | Float | Positive elevation difference | | negative | Float | Negative elevation difference | | average | Float | Average elevation |

Author

| Property | Type | Description | | -------- | ------------ | --------------------------- | | name | String | Author name | | email | Email object | Email address of the author | | link | Link object | Web address |

Email

| Property | Type | Description | | -------- | ------ | ------------ | | id | String | Email id | | domain | String | Email domain |

Link

| Property | Type | Description | | -------- | ------ | ----------- | | href | String | Web address | | text | String | Link text | | type | String | Link type |