Skip to content

FLUT-965284 - [Feature] Added Gauges UG improvement changes. #1278

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: development
Choose a base branch
from
Open

FLUT-965284 - [Feature] Added Gauges UG improvement changes. #1278

wants to merge 2 commits into from

Conversation

BPraveenBalu
Copy link
Collaborator

@BPraveenBalu BPraveenBalu commented Jul 7, 2025 •
edited
Loading

Feature description

Review and update the API documentation for the radial gauge and linear gauge widgets.

Key objectives:

  • Ensure all public APIs are fully documented.
  • Ensure the inclusion of correct hyperlinks, default property values in documentation.
  • Ensure the public APIs content were correct in the documentation.

Analysis and design

  • Task ID - [FLUT-965285]
  • Audit all public APIs in the gauges widget to ensure comprehensive documentation.
  • Identify any undocumented APIs and draft descriptive content, including usage examples.
  • Verify that all API entries contain appropriate hyperlinks for seamless developer reference.
  • Confirm that default property values are clearly specified across all relevant entries.
  • Detect and correct inaccuracies or misleading information in the existing documentation.
  • Issue noted document link - Gauges UG documentation issues

Solution description

  • Verified the full set of APIs by cross-checking with the API reference on pub.dev.
  • Identified missing APIs and added comprehensive documentation for them.
  • Reviewed and updated the documentation to include any missing hyperlinks for accurate cross-referencing.
  • Assessed the API documentation content for accuracy and made necessary corrections.
  • Validated default property values and updated them where discrepancies were found.

Output screenshots

Added images for missing API:
edgeStyle

edge_style

onCreatePointerRenderer

on-create-pointer-renderer

Areas affected and ensured

Code snippets and content have been affected due to the modification.

API Changes

Missed API in this documentation changes

  • edgeStyle - Added
  • onCreatePointerRenderer - Added
  • onAnimationCompleted - Added
  • factorToValueCallback - Not needed, Mostly we don't use any factor values in slider labels.

Behavioral Changes

No behavioral changes due to this modification.

Test cases

No test cases for this PR.

Testbed sample location

No needed for this specific task.

Does it have any known issues?

No.

Does it have memory leak?

Not applicable

MR CheckList

  • Does it follow the design guidelines? It is mandatory that, we should not move the changes without reading this. Yes, followed the guidelines
  • Did UI automation passed without errors? If it is customer issue, make sure it is included in the IR automation. It is a documentation related work, so Not applicable
  • Properly working in Xamarin.Forms previewer.
  • Ensured in iOS, Android, UWP and macOS (if supported). Not applicable
  • Have you added API comments if it is new API? Not applicable
  • Does it need localization? If so, update resx file in GitHub. Not applicable
  • Whether we have added new APIs? If so, whether it is as per the guidelines? Not applicable
  • If changes are made in the Xamarin.Forms sample browser project file, whether it is included in the props file too? If not, your sample level changes will not reflect in the application published in the hockey app. Not applicable
  • Have you ensured the changes in Android API 19 and iOS 9? Not applicable

@SyncfusionBuild
Copy link
Contributor

Your pull request has been created. Syncfusion support team will validate this commit and publish your changes accordingly.

@SyncfusionBuild
Copy link
Contributor

Build Status: INPROGRESS 🔃
Build Location: FLUT-965284-Gauges-UG-changes

@SyncfusionBuild
Copy link
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: FLUT-965284-Gauges-UG-changes
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

@BPraveenBalu BPraveenBalu changed the title FLUT-965284 - [Others] Included a Gauges UG improvement changes. FLUT-965284 - [Feature] Included a Gauges UG improvement changes. Jul 8, 2025
@BPraveenBalu BPraveenBalu changed the title FLUT-965284 - [Feature] Included a Gauges UG improvement changes. FLUT-965284 - [Feature] Added Gauges UG improvement changes. Jul 15, 2025
@sfHariHaraSudhan sfHariHaraSudhan changed the base branch from master to development July 18, 2025 11:57
sfHariHaraSudhan
sfHariHaraSudhan approved these changes Jul 18, 2025
View reviewed changes
Copy link
Collaborator

@sfHariHaraSudhan sfHariHaraSudhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved.

Flutter/linear-gauge/animation.md
@@ -114,7 +114,29 @@ Both the shape and widget marker pointers have the same set of properties and be

![Animate marker pointer in linear gauge](images/animation/shape-pointer/bounceout.gif)

## Event
Copy link
Collaborator

@sfHariHaraSudhan sfHariHaraSudhan Jul 18, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why named the heading as Event alone instead of Animation Completed?

Flutter/linear-gauge/animation.md

The [`onAnimationCompleted`](https://pub.dev/documentation/syncfusion_flutter_gauges/latest/gauges/LinearShapePointer/onAnimationCompleted.html) called when the pointer animation is completed. The default value is null.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we mention or highlight the null as 'null'?

sfHariHaraSudhan
sfHariHaraSudhan approved these changes Jul 18, 2025
View reviewed changes
Copy link
Collaborator

@sfHariHaraSudhan sfHariHaraSudhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved.

Flutter/radial-gauge/pointers.md
@@ -136,4 +136,47 @@ Pointers can be dragged over the scale to change their values interactively. Thi

{% endhighlight %}

The [`onCreatePointerRenderer`](https://pub.dev/documentation/syncfusion_flutter_gauges/latest/gauges/MarkerPointer/onCreatePointerRenderer.html) callback used to create a custom pointer in the radial gauge. This callback available only in [`needlePointer`](https://pub.dev/documentation/syncfusion_flutter_gauges/latest/gauges/NeedlePointer-class.html) and [`markerPointer`](https://pub.dev/documentation/syncfusion_flutter_gauges/latest/gauges/MarkerPointer-class.html).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This callback is available only in two pointers, such as NeedlePointer and MarkerPointer.

But recheck it once and modify it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sfHariHaraSudhan sfHariHaraSudhan sfHariHaraSudhan approved these changes

@VijayakumarMariappan VijayakumarMariappan Awaiting requested review from VijayakumarMariappan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@BPraveenBalu @SyncfusionBuild @sfHariHaraSudhan