software.amazon.awscdk.services.cloudwatch

Interface HorizontalAnnotation

All Known Implementing Classes:

HorizontalAnnotation.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.007Z")
public interface HorizontalAnnotation

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 and Description
static class	HorizontalAnnotation.Builder A builder for HorizontalAnnotation
static class	HorizontalAnnotation.Jsii$Proxy An implementation for HorizontalAnnotation

Method Summary

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

Method Detail

getValue

java.lang.Number getValue()

The value of the annotation.

getColor

default java.lang.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

default Shading getFill()

Add shading above or below the annotation.

Default: No shading

getLabel

default java.lang.String getLabel()

Label for the annotation.

Default: - No label

getVisible

default java.lang.Boolean getVisible()

Whether the annotation is visible.

Default: true

builder

static HorizontalAnnotation.Builder builder()

Returns:

a HorizontalAnnotation.Builder of HorizontalAnnotation