Interface YAxisProps

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

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:15.900Z") @Stability(Stable) public interface YAxisProps extends software.amazon.jsii.JsiiSerializable
Properties for a Y-Axis.

Example:

 Dashboard dashboard;
 Alarm errorAlarm;
 Metric gaugeMetric;
 dashboard.addWidgets(GaugeWidget.Builder.create()
         .metrics(List.of(gaugeMetric))
         .leftYAxis(YAxisProps.builder()
                 .min(0)
                 .max(1000)
                 .build())
         .build());
 
  • Method Details

    • getLabel

      @Stability(Stable) @Nullable default String getLabel()
      The label.

      Default: - No label

    • getMax

      @Stability(Stable) @Nullable default Number getMax()
      The max value.

      Default: - No maximum value

    • getMin

      @Stability(Stable) @Nullable default Number getMin()
      The min value.

      Default: 0

    • getShowUnits

      @Stability(Stable) @Nullable default Boolean getShowUnits()
      Whether to show units.

      Default: true

    • builder

      @Stability(Stable) static YAxisProps.Builder builder()
      Returns:
      a YAxisProps.Builder of YAxisProps