Interface GraphWidgetProps

All Superinterfaces:, MetricWidgetProps
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.862Z") @Stability(Stable) public interface GraphWidgetProps extends, MetricWidgetProps
Properties for a GraphWidget.


 Dashboard dashboard;
         // ...
  • Method Details

    • getLeft

      @Stability(Stable) @Nullable default List<IMetric> getLeft()
      Metrics to display on left Y axis.

      Default: - No metrics

    • getLeftAnnotations

      @Stability(Stable) @Nullable default List<HorizontalAnnotation> getLeftAnnotations()
      Annotations for the left Y axis.

      Default: - No annotations

    • getLeftYAxis

      @Stability(Stable) @Nullable default YAxisProps getLeftYAxis()
      Left Y axis.

      Default: - None

    • getLegendPosition

      @Stability(Stable) @Nullable default LegendPosition getLegendPosition()
      Position of the legend.

      Default: - bottom

    • getLiveData

      @Stability(Stable) @Nullable default Boolean getLiveData()
      Whether the graph should show live data.

      Default: false

    • getPeriod

      @Stability(Stable) @Nullable default Duration getPeriod()
      The default period for all metrics in this widget.

      The period is the length of time represented by one data point on the graph. This default can be overridden within each metric definition.

      Default: cdk.Duration.seconds(300)

    • getRight

      @Stability(Stable) @Nullable default List<IMetric> getRight()
      Metrics to display on right Y axis.

      Default: - No metrics

    • getRightAnnotations

      @Stability(Stable) @Nullable default List<HorizontalAnnotation> getRightAnnotations()
      Annotations for the right Y axis.

      Default: - No annotations

    • getRightYAxis

      @Stability(Stable) @Nullable default YAxisProps getRightYAxis()
      Right Y axis.

      Default: - None

    • getSetPeriodToTimeRange

      @Stability(Stable) @Nullable default Boolean getSetPeriodToTimeRange()
      Whether to show the value from the entire time range. Only applicable for Bar and Pie charts.

      If false, values will be from the most recent period of your chosen time range; if true, shows the value from the entire time range.

      Default: false

    • getStacked

      @Stability(Stable) @Nullable default Boolean getStacked()
      Whether the graph should be shown as stacked lines.

      Default: false

    • getStatistic

      @Stability(Stable) @Nullable default String getStatistic()
      The default statistic to be displayed for each metric.

      This default can be overridden within the definition of each individual metric

      Default: - The statistic for each metric is used

    • getView

      @Stability(Stable) @Nullable default GraphWidgetView getView()
      Display this metric.

      Default: TimeSeries

    • builder

      @Stability(Stable) static GraphWidgetProps.Builder builder()
      a GraphWidgetProps.Builder of GraphWidgetProps