Interface VerticalAnnotation

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
VerticalAnnotation.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-27T16:50:54.550Z") @Stability(Stable) public interface VerticalAnnotation extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.cloudwatch.*;
 VerticalAnnotation verticalAnnotation = VerticalAnnotation.builder()
         .date("date")
         // the properties below are optional
         .color("color")
         .fill(VerticalShading.NONE)
         .label("label")
         .visible(false)
         .build();
 
  • Method Details

    • getDate

      @Stability(Stable) @NotNull String getDate()
      The date and time (in ISO 8601 format) in the graph where the vertical annotation line is to appear.
    • 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 VerticalShading getFill()
      Add shading before or after 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 VerticalAnnotation.Builder builder()
      Returns:
      a VerticalAnnotation.Builder of VerticalAnnotation