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

Split TimeSeriesScalar into Scalar and SeriesStyle #4816

Closed
Tracked by #4813
nikolausWest opened this issue Jan 15, 2024 · 1 comment
Closed
Tracked by #4813

Split TimeSeriesScalar into Scalar and SeriesStyle #4816

nikolausWest opened this issue Jan 15, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request 🍏 primitives Relating to Rerun primitives
Milestone

Comments

@nikolausWest
Copy link
Member

nikolausWest commented Jan 15, 2024

The TimeSeriesScalar archetype currently does a poor job of separating data modeling ("hey this entity is a scalar with this value") from configuring a view. At log time, the user shouldn't have to decide if a scalar should be shown as a TimeSeries, or for instance a gauge (although we don't currently have a gauge view). In addition, many options that you'd like to be able to for the styling of the series only really make sense to apply to the whole series. We should therefore encourage users to only log / set those once.

I propose we split TimeSeriesScalar into two archetypes:

Scalar

Components:

  • Required: Scalar
  • Optional: Text

SeriesStyle

Includes any options for styling the series (as seen in a time-series plot) that result from a range query on the entity.

For instance:

  • What mark to use: dot/circle, line, bar
  • Area fill color and opacity
  • Stroke options (color, width)
  • Whether to draw the series as stacked or not (for line and bar marks)
  • The display name / label for the series (Note: this needs to be a component other than Text)

Remember: Each added option needs to also come with setting the relevant egui_plot options.

@Wumpf
Copy link
Member

Wumpf commented Feb 6, 2024

The split has been done. What we haven't done is some of the additional properties we want. Most notably:

  • area (fill & opacity)
  • text on scalars shown as scalar labels

everything else is covered. Meaning we're done here in the original sense of the ticket :)

@Wumpf Wumpf closed this as completed Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request 🍏 primitives Relating to Rerun primitives
Projects
None yet
Development

No branches or pull requests

3 participants