Class GraphWidgetProps
Properties for a GraphWidget.
Inheritance
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.AWS.CloudWatch.dll
Syntax (csharp)
public class GraphWidgetProps : Object, IGraphWidgetProps, IMetricWidgetProps
Syntax (vb)
Public Class GraphWidgetProps
Inherits Object
Implements IGraphWidgetProps, IMetricWidgetProps
Remarks
ExampleMetadata: infused
Examples
Dashboard dashboard;
dashboard.AddWidgets(new GraphWidget(new GraphWidgetProps {
// ...
LegendPosition = LegendPosition.RIGHT
}));
Synopsis
Constructors
GraphWidgetProps() |
Properties
Height | Height of the widget. |
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. |
Region | The region the metrics of this graph should be taken from. |
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. |
Statistic | The default statistic to be displayed for each metric. |
Title | Title for the graph. |
View | Display this metric. |
Width | Width of the widget, in a grid of 24 units wide. |
Constructors
GraphWidgetProps()
public GraphWidgetProps()
Properties
Height
Height of the widget.
public Nullable<double> Height { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - 6 for Alarm and Graph widgets. 3 for single value widgets where most recent value of a metric is displayed.
Left
Metrics to display on left Y axis.
public IMetric[] Left { get; set; }
Property Value
IMetric[]
Remarks
Default: - No metrics
LeftAnnotations
Annotations for the left Y axis.
public IHorizontalAnnotation[] LeftAnnotations { get; set; }
Property Value
Remarks
Default: - No annotations
LeftYAxis
Left Y axis.
public IYAxisProps LeftYAxis { get; set; }
Property Value
Remarks
Default: - None
LegendPosition
Position of the legend.
public Nullable<LegendPosition> LegendPosition { get; set; }
Property Value
System.Nullable<LegendPosition>
Remarks
Default: - bottom
LiveData
Whether the graph should show live data.
public Nullable<bool> LiveData { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Period
The default period for all metrics in this widget.
public Duration Period { get; set; }
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)
Region
The region the metrics of this graph should be taken from.
public string Region { get; set; }
Property Value
System.String
Remarks
Default: - Current region
Right
Metrics to display on right Y axis.
public IMetric[] Right { get; set; }
Property Value
IMetric[]
Remarks
Default: - No metrics
RightAnnotations
Annotations for the right Y axis.
public IHorizontalAnnotation[] RightAnnotations { get; set; }
Property Value
Remarks
Default: - No annotations
RightYAxis
Right Y axis.
public IYAxisProps RightYAxis { get; set; }
Property Value
Remarks
Default: - None
SetPeriodToTimeRange
Whether to show the value from the entire time range. Only applicable for Bar and Pie charts.
public Nullable<bool> SetPeriodToTimeRange { get; set; }
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.
public Nullable<bool> Stacked { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Statistic
The default statistic to be displayed for each metric.
public string Statistic { get; set; }
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
Title
Title for the graph.
public string Title { get; set; }
Property Value
System.String
Remarks
Default: - None
View
Display this metric.
public Nullable<GraphWidgetView> View { get; set; }
Property Value
System.Nullable<GraphWidgetView>
Remarks
Default: TimeSeries
Width
Width of the widget, in a grid of 24 units wide.
public Nullable<double> Width { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 6