gpx.studio

https://gpx.studio/help
Admin
gpx.studio is an online tool for planning, editing, and managing GPX routes and data, providing...
Tokens:10,628
Snippets:12
Trust Score:8.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Embed gpx.studio Map

Source: https://gpx.studio/help/integration

This snippet shows how to embed a gpx.studio map into your website using an iframe. It requires a Mapbox access token and a URL to a GPX file. The embed code allows customization of width, height, and other options via URL parameters.

```html
<iframe src="https://gpx.studio/embed?options=%7B%22token%22%3A%22YOUR_MAPBOX_TOKEN%22%2C%22files%22%3A%5B%22https%3A%2F%2Fraw.githubusercontent.com%2Fgpxstudio%2Fgpx.studio%2Fmain%2Fgpx%2Ftest-data%2Fsimple.gpx%22%5D%7D" width="100%" height="600px" frameborder="0" style="outline: none;"/>
```

--------------------------------

### Custom Map Source URLs

Source: https://gpx.studio/help/map-controls

Advanced users can add custom basemaps and overlays by providing URLs for various tile service protocols or map style definitions. This allows for greater flexibility in map visualization.

```APIDOC
Custom Map Sources:
  - WMTS (Web Map Tile Service): For tiled map layers.
  - WMS (Web Map Service): For map image layers.
  - Mapbox style JSON: For defining custom map styles compatible with Mapbox GL JS.
```

--------------------------------

### GPX Studio Additional Route Tools

Source: https://gpx.studio/help/toolbar/routing

Describes utility tools available in GPX Studio for modifying existing routes. These tools automate common operations like reversing direction or creating loops.

```APIDOC
GPX Studio Additional Route Tools:

- Reverse Route: Reverses the direction of the entire route.
- Connect to Start: Connects the last point of the route with the starting point using the current routing settings.
- Return to Start: Creates a route that goes from the end point back to the starting point via the same calculated path.
- Change Loop Start: When the end point is close to the start, click any anchor point and select an option to change the loop's starting point.
```

--------------------------------

### GPX Studio Route Plotting and Editing

Source: https://gpx.studio/help/toolbar/routing

Details the methods for creating, editing, and extending routes within GPX Studio. It covers placing anchor points, rerouting segments, inserting new points, and handling imported GPX files.

```APIDOC
GPX Studio Route Plotting and Editing:

- Creating/Extending Routes: Click on the map to place a new anchor point.
- Rerouting Segments: Drag an existing anchor point to reroute the connecting segment.
- Inserting Anchor Points: Hover over a segment and drag the appearing anchor point to the desired location. On touch devices, tap the segment.
- Editing Imported Files: Anchor points are created automatically. More points are displayed as the map zooms in for detailed editing.
- Deleting Anchor Points: Click on an anchor point and select the delete option.
```

--------------------------------

### File Item Information and Appearance

Source: https://gpx.studio/help/menu/edit

Provides dialogs to manage the properties and visual representation of selected file items. Users can edit names, descriptions, colors, opacity, and line width.

```APIDOC
File Item Management:
  Information Dialog:
    - Purpose: View and edit the name and description of the selected file item.
    - Access: Typically opened via a dedicated button or context menu.

  Appearance Dialog:
    - Purpose: Customize the visual appearance of selected file items on the map.
    - Options:
      - Color: Change the display color.
      - Opacity: Adjust transparency.
      - Width: Modify the line thickness.
```

--------------------------------

### GPX Studio Routing Settings

Source: https://gpx.studio/help/toolbar/routing

Explains the settings available in the GPX Studio routing tool dialog to control route calculation behavior. These settings tailor routes based on activity type and road network considerations.

```APIDOC
GPX Studio Routing Settings:

- Bike: Select a trace to use the routing tool, or click on the map to start creating a new route.
- Routing Enabled: Anchor points placed or moved on the map will be connected by a route calculated on the OpenStreetMap road network. Disable routing to connect anchor points with straight lines. This setting can also be toggled by pressing `F5`.
- Activity Type: Select the activity type to tailor the routes for (e.g., cycling, walking).
- Consider Private Roads: When enabled, the routing engine will consider private roads when computing routes. Use with caution and only if you have permission.
```

--------------------------------

### Selection and Clipboard Operations

Source: https://gpx.studio/help/menu/edit

Manages the selection of file items and facilitates copying, cutting, and pasting operations using the clipboard. These actions are often dependent on the tree layout being enabled.

```APIDOC
Selection and Clipboard:
  Add to Selection:
    - Action: Adds all file items in the current hierarchy level to the current selection.

  Copy:
    - Condition: Available only when the tree layout is enabled.
    - Action: Copies the selected file items to the clipboard.

  Cut:
    - Condition: Available only when the tree layout is enabled.
    - Action: Cuts the selected file items to the clipboard.

  Paste:
    - Condition: Available only when the tree layout is enabled.
    - Action: Pastes file items from the clipboard to the current hierarchy level, provided they are compatible.

  Delete:
    - Action: Deletes the selected file items.
```

--------------------------------

### Creating and Editing Points of Interest

Source: https://gpx.studio/help/toolbar/poi

Describes the process of adding new points of interest (POIs) or modifying existing ones within GPX Studio. Users can define POIs by filling out a form with details like name, description, icon, link, latitude, and longitude, or by interacting directly with the map. The form also allows for manual coordinate entry.

```APIDOC
Feature: Points of Interest (POIs)

Purpose: To mark and manage specific locations within GPX files.

Functionality:
- Add new POIs to GPX files.
- Edit existing POIs.
- Move POIs by dragging on the map.

Creation/Editing Form Fields:
- Name: Text
- Description: Text
- Icon: Selection (e.g., from a list of icons)
- Link: URL
- Latitude: Numeric (decimal degrees)
- Longitude: Numeric (decimal degrees)

Input Methods:
1. Map Interaction: Click on the map to set the location.
2. Manual Entry: Input Latitude and Longitude coordinates directly.
3. File Selection: Select a GPX file to create or edit POIs within it.

Output:
- Updated GPX file with POI data.

Related Actions:
- Route planning and editing
- Crop and split functionality
```

--------------------------------

### Creation of Tracks and Segments

Source: https://gpx.studio/help/menu/edit

Enables the creation of new tracks within a selected file or new segments within a selected track. These actions are context-dependent and require specific selection criteria.

```APIDOC
Creation Actions:
  Create New Track:
    - Condition: Available only when the tree layout is enabled and the selection is a single file.
    - Action: Creates a new track within the selected file.

  Create New Segment:
    - Condition: Available only when the tree layout is enabled and the selection is a single track.
    - Action: Creates a new segment within the selected track.
```

--------------------------------

### GPX Studio Extract Tool Functionality

Source: https://gpx.studio/help/toolbar/extract

Explains the core functionality of the GPX Studio extract tool. It allows users to extract individual tracks or segments from GPX files containing multiple entries. The tool also handles the assignment of points of interest (POIs) to the closest extracted track.

```APIDOC
GPX Studio Extract Tool:
  Purpose: Extracts tracks (or segments) from files (or tracks) containing multiple of them.
  Behavior:
    - Applying to a file with multiple tracks: Creates a new file for each track.
    - Applying to a track with multiple segments: Creates a new track for each segment within the same file.
  Points of Interest (POIs):
    - Automatically assigns each point of interest to the track it is closest to during extraction.
  Prerequisites:
    - The selection must contain items with multiple traces to extract them.
```

--------------------------------

### Undo/Redo Actions

Source: https://gpx.studio/help/menu/edit

Allows users to revert or reapply the last performed actions. This functionality applies to most interface actions but excludes view options, application settings, and map navigation.

```APIDOC
Undo/Redo:
  - Reverts or reapplies the last performed actions.
  - Scope: Applies to all interface actions except view options, application settings, and map navigation.
  - Usage: Accessible via dedicated buttons or context menus.
```

--------------------------------

### File Item Visibility and Map Centering

Source: https://gpx.studio/help/menu/edit

Controls the visibility of selected file items on the map and allows centering the map view on them. Visibility can be toggled on or off.

```APIDOC
Visibility and Centering:
  Toggle Visibility:
    - Action: Toggles the visibility of selected file items on the map.
    - Usage: Accessible via a dedicated button or context menu.

  Center Map:
    - Action: Centers the map view on the selected file items.
    - Usage: Accessible via a dedicated button or context menu.
```
Tokens:
Raw