Interface IGraphWidgetProps
Properties for a GraphWidget.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IGraphWidgetProps : IMetricWidgetProps
Syntax (vb)
Public Interface IGraphWidgetProps
Inherits IMetricWidgetProps
Remarks
ExampleMetadata: infused
Examples
Dashboard dashboard;
dashboard.AddWidgets(new GraphWidget(new GraphWidgetProps {
// ...
LegendPosition = LegendPosition.RIGHT
}));
Synopsis
Properties
End | The end of the time range to use for each widget independently from those of the dashboard. |
Left | Metrics to display on left Y axis. |
LeftAnnotations | Annotations for the left Y axis. |
LeftYAxis | Left Y axis. |
LegendPosition | Position of the legend. |
LiveData | Whether the graph should show live data. |
Period | The default period for all metrics in this widget. |
Right | Metrics to display on right Y axis. |
RightAnnotations | Annotations for the right Y axis. |
RightYAxis | Right Y axis. |
SetPeriodToTimeRange | Whether to show the value from the entire time range. Only applicable for Bar and Pie charts. |
Stacked | Whether the graph should be shown as stacked lines. |
Start | The start of the time range to use for each widget independently from those of the dashboard. |
Statistic | The default statistic to be displayed for each metric. |
VerticalAnnotations | Annotations for the X axis. |
View | Display this metric. |
Properties
End
The end of the time range to use for each widget independently from those of the dashboard.
virtual string End { get; }
Property Value
System.String
Remarks
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.
Left
Metrics to display on left Y axis.
virtual IMetric[] Left { get; }
Property Value
IMetric[]
Remarks
Default: - No metrics
LeftAnnotations
Annotations for the left Y axis.
virtual IHorizontalAnnotation[] LeftAnnotations { get; }
Property Value
Remarks
Default: - No annotations
LeftYAxis
Left Y axis.
virtual IYAxisProps LeftYAxis { get; }
Property Value
Remarks
Default: - None
LegendPosition
Position of the legend.
virtual Nullable<LegendPosition> LegendPosition { get; }
Property Value
System.Nullable<LegendPosition>
Remarks
Default: - bottom
LiveData
Whether the graph should show live data.
virtual Nullable<bool> LiveData { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Period
The default period for all metrics in this widget.
virtual Duration Period { get; }
Property Value
Remarks
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)
Right
Metrics to display on right Y axis.
virtual IMetric[] Right { get; }
Property Value
IMetric[]
Remarks
Default: - No metrics
RightAnnotations
Annotations for the right Y axis.
virtual IHorizontalAnnotation[] RightAnnotations { get; }
Property Value
Remarks
Default: - No annotations
RightYAxis
Right Y axis.
virtual IYAxisProps RightYAxis { get; }
Property Value
Remarks
Default: - None
SetPeriodToTimeRange
Whether to show the value from the entire time range. Only applicable for Bar and Pie charts.
virtual Nullable<bool> SetPeriodToTimeRange { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
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
Stacked
Whether the graph should be shown as stacked lines.
virtual Nullable<bool> Stacked { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Start
The start of the time range to use for each widget independently from those of the dashboard.
virtual string Start { get; }
Property Value
System.String
Remarks
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.
Statistic
The default statistic to be displayed for each metric.
virtual string Statistic { get; }
Property Value
System.String
Remarks
This default can be overridden within the definition of each individual metric
Default: - The statistic for each metric is used
VerticalAnnotations
Annotations for the X axis.
virtual IVerticalAnnotation[] VerticalAnnotations { get; }
Property Value
Remarks
Default: - No annotations
View
Display this metric.
virtual Nullable<GraphWidgetView> View { get; }
Property Value
System.Nullable<GraphWidgetView>
Remarks
Default: TimeSeries