Skip to content

docs(cloudwatch): correct default value for YAxisProps, refactor GaugeWidget code #35333

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

Merged
merged 3 commits into from
Aug 27, 2025
Merged

docs(cloudwatch): correct default value for YAxisProps, refactor GaugeWidget code #35333

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7c852c
docs(cloudwatch): correct default value for YAxisProps, refactor Gaug…
iankhou Aug 26, 2025
f45e0c0
integ snapshot update
iankhou Aug 26, 2025
b0870a7
Merge branch 'main' into iankhou-cw-yaxis
mergify[bot] Aug 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions ...ge-alarm.js.snapshot/GaugeAlarmIntegrationTestDefaultTestDeployAssertF43E2A2D.assets.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ...dk-testing/framework-integ/test/aws-cloudwatch/test/integ.gauge-alarm.js.snapshot/cdk.out
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 5 additions & 4 deletions ...work-integ/test/aws-cloudwatch/test/integ.gauge-alarm.js.snapshot/gauge-alarm.assets.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ...rk-integ/test/aws-cloudwatch/test/integ.gauge-alarm.js.snapshot/gauge-alarm.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"QueueName"
]
},
"\"]],\"yAxis\":{\"left\":{\"max\":500,\"min\":0}}}}]}"
"\"]],\"yAxis\":{\"left\":{\"min\":0,\"max\":500}}}}]}"
]
]
},
Expand Down
5 changes: 3 additions & 2 deletions ...testing/framework-integ/test/aws-cloudwatch/test/integ.gauge-alarm.js.snapshot/integ.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

508 changes: 505 additions & 3 deletions ...ting/framework-integ/test/aws-cloudwatch/test/integ.gauge-alarm.js.snapshot/manifest.json
View file
Open in desktop

Large diffs are not rendered by default.

153 changes: 1 addition & 152 deletions ...-testing/framework-integ/test/aws-cloudwatch/test/integ.gauge-alarm.js.snapshot/tree.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 8 additions & 9 deletions packages/aws-cdk-lib/aws-cloudwatch/lib/graph.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,14 @@ export interface YAxisProps {
/**
* The min value
*
* @default 0
* @default - Auto
*/
readonly min?: number;

/**
* The max value
*
* @default - No maximum value
* @default - Auto
*/
readonly max?: number;

Expand Down Expand Up @@ -175,7 +175,7 @@ export interface GaugeWidgetProps extends MetricWidgetProps {
/**
* Left Y axis
*
* @default - None
* @default {min:0,max:100}
*/
readonly leftYAxis?: YAxisProps;

Expand Down Expand Up @@ -273,11 +273,6 @@ export class GaugeWidget extends ConcreteWidget {

public toJson(): any[] {
const metrics = allMetricsGraphJson(this.metrics, []);
const leftYAxis = {
...this.props.leftYAxis,
min: this.props.leftYAxis?.min ?? 0,
max: this.props.leftYAxis?.max ?? 100,
};
return [{
type: 'metric',
width: this.width,
Expand All @@ -291,7 +286,11 @@ export class GaugeWidget extends ConcreteWidget {
metrics: metrics.length > 0 ? metrics : undefined,
annotations: (this.props.annotations ?? []).length > 0 ? { horizontal: this.props.annotations } : undefined,
yAxis: {
left: leftYAxis ?? undefined,
Copy link
Contributor Author

@iankhou iankhou Aug 26, 2025

Choose a reason for hiding this comment

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

undefined here is dead code.

left: {
min: 0,
max: 100,
...this.props.leftYAxis,
},
},
legend: this.props.legendPosition !== undefined ? { position: this.props.legendPosition } : undefined,
liveData: this.props.liveData,
Expand Down
Loading