Class TableWidgetProps
Properties for a TableWidget.
Inheritance
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class TableWidgetProps : Object, ITableWidgetProps, IMetricWidgetProps
Syntax (vb)
Public Class TableWidgetProps
Inherits Object
Implements ITableWidgetProps, IMetricWidgetProps
Remarks
ExampleMetadata: infused
Examples
Dashboard dashboard;
dashboard.AddWidgets(new TableWidget(new TableWidgetProps {
// ...
Layout = TableLayout.VERTICAL
}));
Synopsis
Constructors
TableWidgetProps() |
Properties
End | The end of the time range to use for each widget independently from those of the dashboard. |
FullPrecision | Whether to show as many digits as can fit, before rounding. |
Height | Height of the widget. |
Layout | Table layout. |
LiveData | Whether the graph should show live data. |
Metrics | Metrics to display in the table. |
Period | The default period for all metrics in this widget. |
Region | The region the metrics of this graph should be taken from. |
SetPeriodToTimeRange | Whether to show the value from the entire time range. Only applicable for Bar and Pie charts. |
ShowUnitsInLabel | Show the metrics units in the label column. |
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. |
Summary | Properties for displaying summary columns. |
Thresholds | Thresholds for highlighting table cells. |
Title | Title for the graph. |
Width | Width of the widget, in a grid of 24 units wide. |
Constructors
TableWidgetProps()
public TableWidgetProps()
Properties
End
The end of the time range to use for each widget independently from those of the dashboard.
public string End { get; set; }
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.
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.
Layout
Table layout.
public Nullable<TableLayout> Layout { get; set; }
Property Value
System.Nullable<TableLayout>
Remarks
Default: - TableLayout.HORIZONTAL
LiveData
Whether the graph should show live data.
public Nullable<bool> LiveData { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Metrics
Metrics to display in the table.
public IMetric[] Metrics { get; set; }
Property Value
IMetric[]
Remarks
Default: - No metrics
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
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
ShowUnitsInLabel
Show the metrics units in the label column.
public Nullable<bool> ShowUnitsInLabel { get; set; }
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.
public string Start { get; set; }
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.
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
Summary
Properties for displaying summary columns.
public ITableSummaryProps Summary { get; set; }
Property Value
Remarks
Default: - no summary columns are shown
Thresholds
Thresholds for highlighting table cells.
public TableThreshold[] Thresholds { get; set; }
Property Value
Remarks
Default: - No thresholds
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