-
Notifications
You must be signed in to change notification settings - Fork 40
FLUT-958965 - [Feature] Cleared grammatical issues for barcode and treemap #1209
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
base: development
Are you sure you want to change the base?
FLUT-958965 - [Feature] Cleared grammatical issues for barcode and treemap #1209
Conversation
Build Status: INPROGRESS 🔃 |
CI Status: SUCCESS ✅ |
@@ -267,7 +268,7 @@ The bar color of the barcode can be customized by using its [`barColor`](https:/ | |||
|
|||
**Background color customization** | |||
|
|||
The background color of barcode can be customized with the [`backgroundColor`](https://pub.dev/documentation/syncfusion_flutter_barcodes/latest/barcodes/SfBarcodeGenerator/backgroundColor.html) property of barcode generator as like the below code snippet, | |||
You can customize the barcode's background color with the [`backgroundColor`](https://pub.dev/documentation/syncfusion_flutter_barcodes/latest/barcodes/SfBarcodeGenerator/backgroundColor.html) property of barcode generator as like the below code snippet, |
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.
Unwanted spacing added
@@ -75,7 +75,7 @@ class PopulationModel { | |||
|
|||
## Slice | |||
|
|||
The [`slice`](https://pub.dev/documentation/syncfusion_flutter_treemap/latest/treemap/SfTreemap/SfTreemap.slice.html) layout will start to arrange each rectangle in a horizontal direction and the size of the rectangle will be based on the value returned from [`weightValueMapper`](https://pub.dev/documentation/syncfusion_flutter_treemap/latest/treemap/SfTreemap/weightValueMapper.html) callback and the available height. | |||
The [`slice`](https://pub.dev/documentation/syncfusion_flutter_treemap/latest/treemap/SfTreemap/SfTreemap.slice.html) layout will arrange each rectangle in a horizontal direction and the size of the rectangle will be based on the value returned from[`weightValueMapper`](https://pub.dev/documentation/syncfusion_flutter_treemap/latest/treemap/SfTreemap/weightValueMapper.html) callback and the available height. |
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.
Spacing removed
|
||
## Enable default legend | ||
|
||
You can show legend by initializing the [`SfTreemap.legend`](https://pub.dev/documentation/syncfusion_flutter_treemap/latest/treemap/SfTreemap/legend.html) property. By default, the legend item's text is rendered based on the value of [`TreemapLevel.groupMapper`](https://pub.dev/documentation/syncfusion_flutter_treemap/latest/treemap/TreemapLevel/groupMapper.html) property. The default value of the [`legend`](https://pub.dev/documentation/syncfusion_flutter_treemap/latest/treemap/SfTreemap/legend.html) property is `null` and hence the legend will not be shown by default. | ||
To display a legend, initialize the [`SfTreemap.legend`](https://pub.dev/documentation/syncfusion_flutter_treemap/latest/treemap/SfTreemap/legend.html) property. By default, the legend item's text is rendered based on the value of [`TreemapLevel.groupMapper`](https://pub.dev/documentation/syncfusion_flutter_treemap/latest/treemap/TreemapLevel/groupMapper.html) property. The default value of the [`legend`](https://pub.dev/documentation/syncfusion_flutter_treemap/latest/treemap/SfTreemap/legend.html) property is `null` meaning the legend is not shown unless specified. |
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.
Remove - meaning the legend is not shown unless specified.
* **Border color** - Change the border color of the tooltip in the treemap using the [`TreemapTooltipSettings.borderColor`](https://pub.dev/documentation/syncfusion_flutter_treemap/latest/treemap/TreemapTooltipSettings/borderColor.html) property. | ||
* **Border width** - Change the border width of the tooltip in the treemap using the [`TreemapTooltipSettings.borderWidth`](https://pub.dev/documentation/syncfusion_flutter_treemap/latest/treemap/TreemapTooltipSettings/borderWidth.html) property. | ||
* **Border radius** - Change the border radius of the tooltip in the treemap using the [`TreemapTooltipSettings.borderRadius`](https://pub.dev/documentation/syncfusion_flutter_treemap/latest/treemap/TreemapTooltipSettings/borderRadius.html) property. | ||
* **Visibility** - Change the duration of the tooltip visibility using the `hideDelay` property. The default value of the `hideDelay` property is 3. By default, tooltip will hide automatically after 3 seconds of inactivity for mobile platforms. Also, you can increase or decrease the tooltip duration or show tooltip always by setting double.infinity to the `hideDelay` property. | ||
|
||
N> For mobile platforms, the hideDelay option is supported. When you hover over the shape, bubble, or marker on the web or desktop, a tooltip will appear. When you remove hover from the shape, it will disappear. | ||
N> For mobile platforms, the hideDelay option is supported. On web or desktop, tooltips appear when hovering over shapes, bubbles, or markers and disappear when the hover is removed. |
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.
Delete note. It seems we copy pasted maps widget.
@@ -184,9 +185,9 @@ Below code snippet shows the one dimensional barcode without the [`module`](http | |||
|
|||
 | |||
|
|||
N> In the image above, the smallest bar line width is calculated on the basis of the available width as a result of the total computed inputs(0's and 1's) divided by the available width. | |||
N> In the image above, the smallest bar line width is calculated based on available width divided by total inputs (0's and 1's). |
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.
Reparaphrase this notes content again
Feature description
Analysis and design
Copy the UG content with code snippet and modify it in Continue AI based on the shared prompt. Modify the shared prompt based on your needs if needed.
Replace the hyperlink given by the AI with the original hyperlink.
Ensure naming casing of the widget.
Replace the existing code snippet alignment with AI code snippet in proper alignment.
Prompt:
Use the prompt below for UG review in AI-Continue.
Review the following User Guide(UG) document based on the criteria below. After reviewing, rewrite and share the updated content. If any modifications are made during the review, clearly indicate what was changed and why.
Review Criteria:
Solution description
Checked and cleared the grammatical issues, paraphrasing for all the barcode and treemap widget UG documentation pages.
Output screenshots
Post the output screenshots if an UI is affected or added due to this feature.
Areas affected and ensured
No, areas affected.
API Changes
List all API changes here (or just put None), example:
Added:
Changed:
Behavioral Changes
No behavioral changes.
Test cases
Provide the unit testing written file details to understand the use cases considered in this implementation.
If there is no TDD (if it’s not possible to follow), provide the UI automation script location and the Excel file that contains the use cases considered in this implementation.
Provide the test cases Excel file alone if the feature cannot be automated in any case.
List out all the scenarios you have tested after include these changes. You can refer the predefined scenarios from below link.
https://syncfusion.atlassian.net/wiki/display/CHARTXAMARIN/Chart+Test+Plan
Testbed sample location
Provide the test bed sample location where code reviewers can review the new feature’s behaviors. This depends on the CI process that your team follows. It can be from NPMCI, HockeyApp, staging site, local server, etc.
Does it have any known issues?
No.
Does it have memory leak?
Not applicable.
MR CheckList