kb0 / dart-gpx

Dart package for load, manipulate, and save GPS data in GPX format (a light-weight XML data format for the interchange of GPS data - waypoints, routes, and tracks).

gpx

A library for or load, manipulate, and save GPS data in GPX format (https://www.topografix.com/gpx.asp, a light-weight XML data format for the interchange of GPS data - waypoints, routes, and tracks). View the official GPX 1.1 Schema at https://www.topografix.com/GPX/1/1/gpx.xsd.

Also support export from Gpx into:

• KML (a file format used to display geographic data in an Earth browser such as Google Earth, https://developers.google.com/kml/)
• CSV (not implemented yet)

Getting Started

In your dart/flutter project add the dependency:

 dependencies:
   ...
   gpx: ^2.2.2

Reading XML

To read XML input use the GpxReader object and function Gpx fromString(String input):

import 'package:gpx/gpx.dart';

main() {
  // create gpx from xml string
  var xmlGpx = GpxReader().fromString('<?xml version="1.0" encoding="UTF-8"?>'
      '<gpx version="1.1" creator="dart-gpx library">'
      '<wpt lat="-25.7996" lon="-62.8666"><ele>10.0</ele><name>Monte Quemado</name><desc>Argentina</desc></wpt>'
      '</gpx>');

  print(xmlGpx);
  print(xmlGpx.wpts);
}

Writing XML

To write object to XML use the GpxWriter object and function String asString(Gpx gpx, {bool pretty = false}):

import 'package:gpx/gpx.dart';

main() {
  // create gpx object
  var gpx = Gpx();
  gpx.creator = "dart-gpx library";
  gpx.wpts = [
    Wpt(lat: 36.62, lon: 101.77, ele: 10.0, name: 'Xining', desc: 'China'),
  ];

  // generate xml string
  var gpxString = GpxWriter().asString(gpx, pretty: true);
  print(gpxString);
}

Export to KML

To export object to KML use the KmlWriter object and function String asString(Gpx gpx, {bool pretty = false}):

import 'package:gpx/gpx.dart';

main() {
  // create gpx object
  var gpx = Gpx();
  gpx.creator = "dart-gpx library";
  gpx.wpts = [
    Wpt(lat: 36.62, lon: 101.77, ele: 10.0, name: 'Xining', desc: 'China'),
  ];

  // generate xml string
  var kmlString = KmlWriter().asString(gpx, pretty: true);
  print(kmlString);

  // generate xml string with altitude mode - clampToGround
  var kmlString = KmlWriter(altitudeMode: AltitudeMode.clampToGround)
      .asString(gpx, pretty: true);
  print(kmlString);
}

Limitations

This is just an initial version of the package. There are still some limitations:

• No support for GPX 1.0.
• Read/write only from strings.
• Doesn't validate schema declarations.

Features and bugs

Please file feature requests and bugs at the issue tracker.

License

The Apache 2.0 License, see LICENSE.

dart-gpx's Issues

Failing GPX file

Hello, I was trying to load this gox file: http://speleotrove.com/mapgazer/files/20160617-La-Hermida-to-Bejes.gpx
but the GpxReader().fromString(xml); throws an exception and I am not able to get the issue out of it.

Any idea what the issue might be?

BTW: thanks for this great project :-)

CDATA in name is not working

Hi,
If we have a waypoint with a string as CDATA, then it is not working.
Example:

<wpt lat="42.410045" lon="9.411127">
<ele>710.7</ele>
<time>2022-04-14T08:50:34.924+02:00</time>
<name><![CDATA[Parking]]></name>
<desc><![CDATA[]]></desc>
<type><![CDATA[]]></type>
</wpt>

It is read by the library as a XmlCDATAEvent, with the correct text, but then in the "_readString" method in gpx_reader.dart, it doesn't take this case into account.

Can you fix it?
I can do a PR if you want.

Thank you for your job !

Save GPX file and upload to Strava

Hello,

Kindly need your help how to save a file GPX because I wanna write the GPX file then upload to Strava. Is this library support to Strava?

Thank you

Null safety

Dart 2.12 requirement and null-safety.

Update xml dependency to 6.0.1

It would be nice if we could update the xml dependency to 6.0.1.
Is there a reason not to do it?

I would love to contribute and create a PR for this.

SDK is Incompatible

Hi,

I tried using "gpx: ^1.1.1" and pub-get returns this error :

Because every version of flutter from sdk depends on meta 1.1.8 and xml >=4.3.0 depends on meta ^1.2.0, flutter from sdk is incompatible with xml >=4.3.0.
And because gpx >=1.0.1+2 depends on xml ^4.3.0, flutter from sdk is incompatible with gpx >=1.0.1+2.
So, because flutter_app depends on both flutter any from sdk and gpx ^1.1.1, version solving failed.
pub get failed (1; So, because flutter_app depends on both flutter any from sdk and gpx ^1.1.1, version solving failed.)

flutter doctor -v

[√] Flutter (Channel stable, 1.20.2, on Microsoft Windows [Version 10.0.18363.1016], locale en-US)
    • Flutter version 1.20.2 at C:\src\flutter
    • Framework revision bbfbf1770c (6 days ago), 2020-08-13 08:33:09 -0700
    • Engine revision 9d5b21729f
    • Dart version 2.9.1

[√] Android toolchain - develop for Android devices (Android SDK version 30.0.2)
    • Android SDK at C:\Users\LK\AppData\Local\Android\sdk
    • Platform android-30, build-tools 30.0.2
    • Java binary at: C:\Program Files\Android\Android Studio\jre\bin\java
    • Java version OpenJDK Runtime Environment (build 1.8.0_242-release-1644-b01)
    • All Android licenses accepted.

[√] Android Studio (version 4.0)
    • Android Studio at C:\Program Files\Android\Android Studio
    • Flutter plugin version 48.0.2
    • Dart plugin version 193.7361
    • Java version OpenJDK Runtime Environment (build 1.8.0_242-release-1644-b01)

[!] Connected device
    ! No devices available

! Doctor found issues in 1 category.

XML 5

Please, give us an update, that allows XML 5.0.0!!!

polygon with points

please, help me with creation of polygon with coordinates on the map. i use flutter google maps package. i need export kml or gpx archive for others programs.

adding garmin extensions

I need to add information to my trk infos, specifically I need to add the speed of each point in the segment.
This is defined by the garmin extension https://www8.garmin.com/xmlschemas/TrackPointExtensionv2.xsd.
As I understand, for each point I can use the extensions map to add additional data for each Wpt point, but how I can add schemas to the Gpx node?

"The file is empty" when uploading to Strava [trkpt vs wpt]

Hi there,

When I upload the file to Strava I get the error message "The file is empty". I think it is because the package uses 'wpt' rather than 'trkpt'. I think Strava only recognizes 'trkpt'. Are there plans to support 'trk' which more represents a track rather than just 'wpt; waypoints?

NB When I manually recreate the same file and replace all 'wpt' references to 'trkpt' and upload manually to Strava it works which is why I think this is the issue.

Any pointers to get around this or plans to add the functionality.

Many thanks..

ele element is missed

Please ignore this