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.

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

0.127.0 (Custom GPX data + misc. improvements) #213

Open
wants to merge 32 commits into
base: main
Choose a base branch
from

Conversation

CyrilSLi
Copy link

@CyrilSLi CyrilSLi commented Sep 18, 2024

Fixes #148

Context

Inserting custom data is useful to display values computed by an external program.

Specific additions in this version:

  • Custom data
    • Custom GPX metadata (global): Access using custom.metadata.{}
    • Custom GPX fields (point-specific): Access using custom.field.{}
    • Custom GPX field which contain a string reference to custom GPX metadata (point-specific): Access using custom.ref.{}
    • custom.float: Unit to use custom data with widgets that expect a float (e.g. chart) and string formatters (e.g. dp)
  • journey_map and moving_journey_map
    • Render GPX waypoints
    • Custom colours and sizes
    • The pos_rgb, pos_size, path_rgb, path_size, wpt_rgb, and wpt_size attributes can be used to set the colour and size/thickness of the current position, the path, and waypoints respectively.
    • Default values from previous version haven't changed
  • moving_map, journey_map and moving_journey_map
    • Ability to set map style at the component level using map_style
    • Corner rounding now multiply instead of replace the alpha channel, allowing transparent map styles to remain transparent
  • Render icons at original size: set size to 0 (useful for HUDs, shadows, etc.)
    • Original-size icons do not have to be square
  • Center-aligned bars (align_center="true")
    • Useful for progress bars and similar
    • h-neg and h-pos are not displayed
    • Set any colour argument to "0,0,0,0" to stop it from being displayed (the space it occupies will be taken by the bar)
  • Add overlay profile for transparent video (duplicate of Problem with transparency. #210?)
  • Search for icon source files relative to XML layout file
  • Bump pint, gpxpy

Contributor Checklist

  • Review Contribution Guidelines
  • Agree to the terms of Developer Certificate of Origin.
  • Make sure all contributed code can be distributed under the terms of the GNU Licence
  • Check "Allow edit from maintainers" option in pull request so that additional changes can be pushed by maintainers if required.
  • Unit tests created/updated (under tests) to verify logic, and approval tests for UI Widgets
  • Update Examples - Under build-scripts/examples, and regenerate examples docs if required ( make doc-examples )
  • Ensure that tests pass locally - this can be tricky for approval tests with maps or text though.
  • Check that pre-release tests work ( make test-distribution )

@CyrilSLi
Copy link
Author

Originally I wrote the docs for new features in docs/xml. I just found out about generate_examples.py, however I am not sure what configuration venv/bin/python3 has (it seems to have been gitignore'd).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Is there any way to display custom data?
1 participant