Class GraphWidget.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<GraphWidget>
- Enclosing class:
- GraphWidget
GraphWidget
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
static GraphWidget.Builder
create()
The end of the time range to use for each widget independently from those of the dashboard.Height of the widget.Metrics to display on left Y axis.leftAnnotations
(List<? extends HorizontalAnnotation> leftAnnotations) Annotations for the left Y axis.leftYAxis
(YAxisProps leftYAxis) Left Y axis.legendPosition
(LegendPosition legendPosition) Position of the legend.Whether the graph should show live data.The default period for all metrics in this widget.The region the metrics of this graph should be taken from.Metrics to display on right Y axis.rightAnnotations
(List<? extends HorizontalAnnotation> rightAnnotations) Annotations for the right Y axis.rightYAxis
(YAxisProps rightYAxis) Right Y axis.setPeriodToTimeRange
(Boolean setPeriodToTimeRange) Whether to show the value from the entire time range.Whether the graph should be shown as stacked lines.The start of the time range to use for each widget independently from those of the dashboard.The default statistic to be displayed for each metric.Title for the graph.verticalAnnotations
(List<? extends VerticalAnnotation> verticalAnnotations) Annotations for the X axis.view
(GraphWidgetView view) Display this metric.Width of the widget, in a grid of 24 units wide.
-
Method Details
-
create
- Returns:
- a new instance of
GraphWidget.Builder
.
-
height
Height of the widget.Default: - 6 for Alarm and Graph widgets. 3 for single value widgets where most recent value of a metric is displayed.
- Parameters:
height
- Height of the widget. This parameter is required.- Returns:
this
-
region
The region the metrics of this graph should be taken from.Default: - Current region
- Parameters:
region
- The region the metrics of this graph should be taken from. This parameter is required.- Returns:
this
-
title
Title for the graph.Default: - None
- Parameters:
title
- Title for the graph. This parameter is required.- Returns:
this
-
width
Width of the widget, in a grid of 24 units wide.Default: 6
- Parameters:
width
- Width of the widget, in a grid of 24 units wide. This parameter is required.- Returns:
this
-
end
The end of the time range to use for each widget independently from those of the dashboard.If you specify a value for end, you must also specify a value for start. Specify an absolute time in the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z.
Default: When the dashboard loads, the end date will be the current time.
- Parameters:
end
- The end of the time range to use for each widget independently from those of the dashboard. This parameter is required.- Returns:
this
-
left
Metrics to display on left Y axis.Default: - No metrics
- Parameters:
left
- Metrics to display on left Y axis. This parameter is required.- Returns:
this
-
leftAnnotations
@Stability(Stable) public GraphWidget.Builder leftAnnotations(List<? extends HorizontalAnnotation> leftAnnotations) Annotations for the left Y axis.Default: - No annotations
- Parameters:
leftAnnotations
- Annotations for the left Y axis. This parameter is required.- Returns:
this
-
leftYAxis
Left Y axis.Default: - None
- Parameters:
leftYAxis
- Left Y axis. This parameter is required.- Returns:
this
-
legendPosition
Position of the legend.Default: - bottom
- Parameters:
legendPosition
- Position of the legend. This parameter is required.- Returns:
this
-
liveData
Whether the graph should show live data.Default: false
- Parameters:
liveData
- Whether the graph should show live data. This parameter is required.- Returns:
this
-
period
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)
- Parameters:
period
- The default period for all metrics in this widget. This parameter is required.- Returns:
this
-
right
Metrics to display on right Y axis.Default: - No metrics
- Parameters:
right
- Metrics to display on right Y axis. This parameter is required.- Returns:
this
-
rightAnnotations
@Stability(Stable) public GraphWidget.Builder rightAnnotations(List<? extends HorizontalAnnotation> rightAnnotations) Annotations for the right Y axis.Default: - No annotations
- Parameters:
rightAnnotations
- Annotations for the right Y axis. This parameter is required.- Returns:
this
-
rightYAxis
Right Y axis.Default: - None
- Parameters:
rightYAxis
- Right Y axis. This parameter is required.- Returns:
this
-
setPeriodToTimeRange
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
- Parameters:
setPeriodToTimeRange
- Whether to show the value from the entire time range. Only applicable for Bar and Pie charts. This parameter is required.- Returns:
this
-
stacked
Whether the graph should be shown as stacked lines.Default: false
- Parameters:
stacked
- Whether the graph should be shown as stacked lines. This parameter is required.- Returns:
this
-
start
The start of the time range to use for each widget independently from those of the dashboard.You can specify start without specifying end to specify a relative time range that ends with the current time. In this case, the value of start must begin with -P, and you can use M, H, D, W and M as abbreviations for minutes, hours, days, weeks and months. For example, -PT8H shows the last 8 hours and -P3M shows the last three months. You can also use start along with an end field, to specify an absolute time range. When specifying an absolute time range, use the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z.
Default: When the dashboard loads, the start time will be the default time range.
- Parameters:
start
- The start of the time range to use for each widget independently from those of the dashboard. This parameter is required.- Returns:
this
-
statistic
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
- Parameters:
statistic
- The default statistic to be displayed for each metric. This parameter is required.- Returns:
this
-
verticalAnnotations
@Stability(Stable) public GraphWidget.Builder verticalAnnotations(List<? extends VerticalAnnotation> verticalAnnotations) Annotations for the X axis.Default: - No annotations
- Parameters:
verticalAnnotations
- Annotations for the X axis. This parameter is required.- Returns:
this
-
view
Display this metric.Default: TimeSeries
- Parameters:
view
- Display this metric. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<GraphWidget>
- Returns:
- a newly built instance of
GraphWidget
.
-