-
Notifications
You must be signed in to change notification settings - Fork 22
docs(native-charts): add chapter for native gauge chart #2590
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
Open
akashsonune
wants to merge
1
commit into
main
Choose a base branch
from
docs/add-chaprt-for-native-gauge-chart
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Native gauge chart | ||
|
|
||
| **Native gauge charts** are lightweight data visualization elements that represent one or more values as a position on a radial arc scale. Unlike the [ECharts-based gauge chart](gauge-chart.md), they require no third-party charting library, making them ideal for performance-sensitive or bundle-size-constrained applications. | ||
|
|
||
| ## Usage --- | ||
|
|
||
| T.B.D | ||
|
|
||
| ## Design --- | ||
|
|
||
| T.B.D | ||
|
|
||
| ## Code --- | ||
|
|
||
| ### Usage | ||
|
|
||
| ```ts | ||
| import { SiNChartGaugeComponent } from '@siemens/native-charts-ng/gauge'; | ||
|
|
||
| @Component({ | ||
| imports: [SiNChartGaugeComponent, ...] | ||
| }) | ||
| ``` | ||
|
|
||
| ### Sum mode | ||
|
|
||
| Multiple series arcs are stacked on the gauge ring. The center shows their combined total. | ||
|
|
||
| <si-docs-component example="si-ncharts/si-nchart-gauge" height="400"></si-docs-component> | ||
|
|
||
| ### Single mode | ||
|
|
||
| A single arc covers the ring. Colored background segments can be layered beneath the arc to indicate qualitative ranges. | ||
|
|
||
| <si-docs-component example="si-ncharts/si-nchart-gauge-single" height="400"></si-docs-component> | ||
|
|
||
| <si-docs-api component="SiNChartGaugeComponent" package="@siemens/native-charts-ng" hideImplicitlyPublic="true"></si-docs-api> | ||
|
|
||
| <si-docs-types></si-docs-types> | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is a technical detail and nothing relevant for UX, wouldn't it make more sense to integrate this into the existing gauge chart chapter?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think there are some feature differences between the two, for which we might need some Ux writing @panch1739?
But yes, from user point of view, I think it makes sense to keep both variants under one chapter.
@dr-itz @panch1739 Since you have more insights into this, WDYT?