Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Section on choosing the elements to be shown #100

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Section on choosing the elements to be shown #100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,25 @@ new L.GPX(url, {
}).addTo(map);
```

### Set which elements are shown on the map

GPX file may contain tracks, routes and waypoints and in standard configurations
all are shown.

You can explicitly tell which elements to show by setting the `parseElements` flag to
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is already described line 65. Maybe we can improve the section earlier in the README with the example you have below instead?

`[ 'track', 'waypoint' ]` in the `gpx_options`:

```javascript
new L.GPX(url, {
gpx_options: {
parseElements: [ 'track', 'waypoint']
}
}).on('loaded', function(e) {
map.fitBounds(e.target.getBounds());
}).addTo(map);
```


## Caveats

* Distance calculation is relatively accurate, but elevation change
Expand Down