Providing more control over hover label in plots #1046
Conversation
egui/src/widgets/plot/mod.rs
Outdated
| let x_decimals = 6 - ((value.x.abs().log10()).ceil().at_least(0.0) as usize).at_most(6); | ||
| let y_decimals = 6 - ((value.y.abs().log10()).ceil().at_least(0.0) as usize).at_most(6); |
There was a problem hiding this comment.
This seems to be used in a few places, also in bar.rs and box_elem.rs -- maybe extract it to a function?
A few similar helper functions are already at the end of items/mod.rs.
egui/src/widgets/plot/mod.rs
Outdated
| type CustomLabelFunc = dyn Fn(&HoverConfig, &str, &Value) -> String; | ||
| type CustomLabelFuncRef = Box<CustomLabelFunc>; |
There was a problem hiding this comment.
Since CustomLabelFuncRef seems to be the prevalent type used everywhere, maybe we should think about a shorter/more precise name? BarChart and BoxPlot have an element_formatter() method, which customizes the displayed text when hovering over them, which is essentially the same concept.
Maybe something like HoverFormatter?
On the other hand, the type dyn Fn(&HoverConfig, &str, &Value) -> String seems to be used only once, so it can either be inlined or use a more verbose name HoverFormatterFn or so.
We are going to need a lot of these customization functions, so agreeing on a term like "formatter" could make sense.
Use cases:
- Hovering for bar charts and box plots (currently
element_formatter, could be renamed tohover_formatter) - Hovering for X/Y values (this PR, maybe
hover_formattermakes clear it's the same idea) - Labeling X/Y axis (#1130, with
x_axis_formatter+y_axis_formatter)
|
It would be great if a demo of the new feature was added to |
This is similar to the AxisFormatterFn and AxisFormatter
|
I have now updated with the comments above and added a new demo. A screenshot of the demo is also included in the original PR description. |
| X, | ||
| Y, | ||
| XY, | ||
| } |
There was a problem hiding this comment.
Seems like it would make more sense to make this into a
pub struct HoverLine {
/// Highlight values on the X axis by painting a vertical line.
pub x: bool,
/// Highlight values on the Y axis by painting a horizontal line.
pub y: bool
}
|
This PR looks really cool! Would love to see this feature merged. |
|
Coverted to a draft until work resumes! |
|
Is this still necessary after merging #1235? |
|
I think it is still needed even though #1235 has merged as this can disable the hover tooltip completely (as well as allowing show_x or show_y to be false but still having a tooltip)? |
|
This will hopefully speed up its development by having more reviewers and maintainers. Please re-open this PR at https://github.com/emilk/egui_plot/pulls See also: |
I found that the label displayed at the cursor when hovering on a plot is only shown if either
show_xorshow_ywere set totrue. I wanted to be able to display the label regardless of whether the line guides were shown or not, and so added in theshow_hover_labelfunction to control this display.I also found that
show_xandshow_yweren't very descriptive names for what functionality they were controlling (originally I thought it was related to the x-axis), so I have suggested a change in name toshow_hover_line_x, but feel free to suggest something more fitting. Similarly withcustom_label_func.Finally, I modified the definition of
CustomLabelFuncto enable a custom function to essentially recreate the default (this wasn't previously possible as it didn't have access toshow_xandshow_y.An example of a custom label
