Class SingleValueWidgetProps

Properties for a SingleValueWidget.

Inheritance
System.Object
SingleValueWidgetProps
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.AWS.CloudWatch.dll
Syntax (csharp)
public class SingleValueWidgetProps : Object, ISingleValueWidgetProps, IMetricWidgetProps
Syntax (vb)
Public Class SingleValueWidgetProps
    Inherits Object
    Implements ISingleValueWidgetProps, IMetricWidgetProps
Remarks

ExampleMetadata: infused

Examples
Dashboard dashboard;
Metric visitorCount;
Metric purchaseCount;


dashboard.AddWidgets(new SingleValueWidget(new SingleValueWidgetProps {
    Metrics = new [] { visitorCount, purchaseCount }
}));

Synopsis

Constructors

SingleValueWidgetProps()

Properties

FullPrecision

Whether to show as many digits as can fit, before rounding.
Height

Height of the widget.
Metrics

Metrics to display.
Region

The region the metrics of this graph should be taken from.
SetPeriodToTimeRange

Whether to show the value from the entire time range.
Title

Title for the graph.
Width

Width of the widget, in a grid of 24 units wide.

Constructors

SingleValueWidgetProps()

public SingleValueWidgetProps()

Properties

FullPrecision

Whether to show as many digits as can fit, before rounding.

public Nullable<bool> FullPrecision { get; set; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

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.

Metrics

Metrics to display.

public IMetric[] Metrics { get; set; }
Property Value

IMetric[]

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

SetPeriodToTimeRange

Whether to show the value from the entire time range.

public Nullable<bool> SetPeriodToTimeRange { get; set; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

Title

Title for the graph.

public string Title { get; set; }
Property Value

System.String

Remarks

Default: - None

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

Implements