Package software.amazon.awscdk.services.cloudwatch

Interface HorizontalAnnotation

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HorizontalAnnotation.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:04.080Z")
@Stability(Stable)
public interface HorizontalAnnotation
extends software.amazon.jsii.JsiiSerializable

Horizontal 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 software.amazon.awscdk.services.cloudwatch.*;
 HorizontalAnnotation horizontalAnnotation = HorizontalAnnotation.builder()
         .value(123)
         // the properties below are optional
         .color("color")
         .fill(Shading.NONE)
         .label("label")
         .visible(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HorizontalAnnotation.Builder	A builder for HorizontalAnnotation
static final class	HorizontalAnnotation.Jsii$Proxy	An implementation for HorizontalAnnotation

Method Summary

Modifier and Type	Method	Description
static HorizontalAnnotation.Builder	builder()
default String	getColor()	The hex color code, prefixed with '#' (e.g.
default Shading	getFill()	Add shading above or below the annotation.
default String	getLabel()	Label for the annotation.
Number	getValue()	The value of the annotation.
default Boolean	getVisible()	Whether the annotation is visible.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getValue

@Stability(Stable)
@NotNull
Number getValue()

The value of the annotation.

getColor

@Stability(Stable)
@Nullable
default String getColor()

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.

Default: - Automatic color

getFill

@Stability(Stable)
@Nullable
default Shading getFill()

Add shading above or below the annotation.

Default: No shading

getLabel

@Stability(Stable)
@Nullable
default String getLabel()

Label for the annotation.

Default: - No label

getVisible

@Stability(Stable)
@Nullable
default Boolean getVisible()

Whether the annotation is visible.

Default: true

builder

@Stability(Stable)
static HorizontalAnnotation.Builder builder()

Returns:

a HorizontalAnnotation.Builder of HorizontalAnnotation