feat(cloudwatch): add support for labels on pie graphs (aws#28929). #30287
Conversation
This file contains 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
github-actions
bot
added
beginning-contributor
1 task
kofrasa
force-pushed
the
cloudwatch-labels-prop
branch
2 times, most recently
from
fdcd22b
to
c0d89d9
Compare
aws-cdk-automation
added
the
pr/needs-community-review
kofrasa
force-pushed
the
cloudwatch-labels-prop
branch
2 times, most recently
from
7f1046b
to
3a0acf4
Compare
kofrasa
force-pushed
the
cloudwatch-labels-prop
branch
2 times, most recently
from
5bb7e01
to
12d4594
Compare
kofrasa
force-pushed
the
cloudwatch-labels-prop
branch
2 times, most recently
from
1c4f9c9
to
787be13
Compare
nmussy
suggested changes
Jun 4, 2024
...ing/framework-integ/test/aws-cloudwatch/test/integ.dashboard-with-graphwidget-with-labels.ts
Outdated
Show resolved
Hide resolved
Comment on lines
44
to
46
| labels: { | ||
| visible: true, | ||
| }, |
There was a problem hiding this comment.
Could you add test cases for labels: {} and labels: {visible: false}, just to make sure CloudFormation handles them properly?
| @@ -496,6 +496,18 @@ dashboard.addWidgets(new cloudwatch.GraphWidget({ | |||
| })); | |||
| ``` | |||
|
|
|||
| When the `view` property is set to `GraphWidgetView.PIE`, the `labels` property can be used to toggle whether the magnitude of a pie segment is shown on the graph as a percentage of the whole. | |||
There was a problem hiding this comment.
Again, I think visible: false can be used for all other widgets types, pie charts just happen to have a different default value?
aws-cdk-automation
removed
the
pr/needs-community-review
kofrasa
force-pushed
the
cloudwatch-labels-prop
branch
4 times, most recently
from
2510a44
to
e7319ce
Compare
|
This PR has been in the BUILD FAILING state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week. |
Add a new "labels" property for graph widgets to support toggling visibility status. === Issue aws#28929 === Closes aws#28929. === Reason for this change === The labels property that allows for toggling the visibility of labels on graphs is currently missing. === Description of changes === The commits adds a new `"labels"` property with the type `LabelProps` on the graph widget. The `LabelProps` type contains a single boolean key`"visible"` which toggles the presence of the label on a pie graph. When set to `true`, CloudWatch dashboard will render the percentage ratios of each segment of the pie graph. The README file has been updated to reflect the new property and how it can be used. === Description of how you validated changes === The commit includes unit, integration, and snapshot tests as would be generated by the CDK library. The change has also been manually verified from the CloudWatch console by enabling and disabling the property. === Checklist === - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
kofrasa
force-pushed
the
cloudwatch-labels-prop
branch
from
e7319ce
to
631f5f0
Compare
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
This PR has been in the BUILD FAILING state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add a new "labels" property for graph widgets to show ratios for pie graphs.
Issue #28929
Closes #28929.
Reason for this change
When using a pie graph, the percentage ratios are not shown unless the
{ "labels": { "visible": true } }property is enabled.Description of changes
The commits adds a new
"labels"property with the typeLabelPropson the graph widget.The
LabelPropstype contains a single boolean key"visible"which toggles the presence of the label on a pie graph. When set totrue, CloudWatch dashboard will render the percentage ratios of each segment of the pie graph.The README file has been updated to reflect the new property and how it can be used.
Description of how you validated changes
The commit includes unit, integration, and snapshot tests as would be generated by the CDK library.
The change has also been manually verified from the CloudWatch console by enabling and disabling the property.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license