[FEATURE] enhance StatChart with text mode options and refactor display l… #524
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ogic - Introduced a new property in the StatChart schema to control how values and names are displayed. - Updated the migration logic to map from panel options and handle various display scenarios. - Refactored the StatChartBase component to utilize for determining what to display (value, name, both, or none). - Adjusted tests and expected outputs to reflect changes in text mode handling. - Enhanced the StatChartOptionsEditorSettings to allow users to select the desired text mode. Signed-off-by: Alexander Belyakin <21216343+abelyakin@users.noreply.github.com>
Contributor
AntoineThebaud
left a comment
AntoineThebaud
left a comment
There was a problem hiding this comment.
Thanks for your PR 🙏 LGTM except the comment below; please also deal with the conflict and we shall get this merged quickly :)
Comment on lines
+40
to
+43
| #grafanaTextMode: *#panel.options.textMode | "auto" | ||
| if #grafanaTextMode != null { | ||
| textMode: #grafanaTextMode | ||
| } |
Contributor
There was a problem hiding this comment.
The if is always mached in the current case as #grafanaTextMod falls back to "auto" (never null), so you should either change to
Suggested change
| #grafanaTextMode: *#panel.options.textMode | "auto" | |
| if #grafanaTextMode != null { | |
| textMode: #grafanaTextMode | |
| } | |
| #grafanaTextMode: *#panel.options.textMode | null | |
| if #grafanaTextMode != null { | |
| textMode: #grafanaTextMode | |
| } |
or
Suggested change
| #grafanaTextMode: *#panel.options.textMode | "auto" | |
| if #grafanaTextMode != null { | |
| textMode: #grafanaTextMode | |
| } | |
| textMode: *#panel.options.textMode | "auto" |
since textMode is an optional attribute I guess the first suggestion makes more sense
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
following issue #501
Implements Grafana's text mode feature to provide users with explicit control over what's displayed in stat panels. Previously, users were confused about when to use metricLabel vs legendFormat, and there was no way to show series names alongside values.
legendFormat: Template for formatting series names (e.g., {{instance}} - {{job}}). Applied to all series for display purposes.
metricLabel: Selects which label's value to display instead of the calculated number (e.g., show the "status" label value like "healthy" or "degraded" rather than a numeric metric).
textMode: Controls what to show - the calculated value, series name, both, or neither.
Updated and simplified the migration logic to map
textModefrom panel options and handle various display scenarios.Grafana's textMode values pass through directly without conversion. Existing panels default to auto for backward compatibility.
Screenshots
text mode = name
text mode = value
text mode = value and name
Checklist
[<catalog_entry>] <commit message>naming convention using one of thefollowing
catalog_entryvalues:FEATURE,ENHANCEMENT,BUGFIX,BREAKINGCHANGE,DOC,IGNORE.UI Changes