interface VerticalAnnotation
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CloudWatch.VerticalAnnotation |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#VerticalAnnotation |
![]() | software.amazon.awscdk.services.cloudwatch.VerticalAnnotation |
![]() | aws_cdk.aws_cloudwatch.VerticalAnnotation |
![]() | aws-cdk-lib » aws_cloudwatch » VerticalAnnotation |
Vertical annotation to be added to a graph.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
const verticalAnnotation: cloudwatch.VerticalAnnotation = {
date: 'date',
// the properties below are optional
color: 'color',
fill: cloudwatch.VerticalShading.NONE,
label: 'label',
visible: false,
};
Properties
Name | Type | Description |
---|---|---|
date | string | The date and time (in ISO 8601 format) in the graph where the vertical annotation line is to appear. |
color? | string | The hex color code, prefixed with '#' (e.g. '#00ff00'), to be used for the annotation. The Color class has a set of standard colors that can be used here. |
fill? | Vertical | Add shading before or after the annotation. |
label? | string | Label for the annotation. |
visible? | boolean | Whether the annotation is visible. |
date
Type:
string
The date and time (in ISO 8601 format) in the graph where the vertical annotation line is to appear.
color?
Type:
string
(optional, default: Automatic color)
The hex color code, prefixed with '#' (e.g. '#00ff00'), to be used for the annotation. The Color
class has a set of standard colors that can be used here.
fill?
Type:
Vertical
(optional, default: No shading)
Add shading before or after the annotation.
label?
Type:
string
(optional, default: No label)
Label for the annotation.
visible?
Type:
boolean
(optional, default: true)
Whether the annotation is visible.