Interface ITableWidgetProps

Properties for a TableWidget.

Inherited Members
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ITableWidgetProps : IMetricWidgetProps
Syntax (vb)
Public Interface ITableWidgetProps
    Inherits IMetricWidgetProps
Remarks

ExampleMetadata: infused

Examples
Dashboard dashboard;


dashboard.AddWidgets(new TableWidget(new TableWidgetProps {
    // ...

    Layout = TableLayout.VERTICAL
}));

Synopsis

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.
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.
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.

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.

FullPrecision

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

virtual Nullable<bool> FullPrecision { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

Layout

Table layout.

virtual Nullable<TableLayout> Layout { get; }
Property Value

System.Nullable<TableLayout>

Remarks

Default: - TableLayout.HORIZONTAL

LiveData

Whether the graph should show live data.

virtual Nullable<bool> LiveData { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

Metrics

Metrics to display in the table.

virtual IMetric[] Metrics { get; }
Property Value

IMetric[]

Remarks

Default: - No metrics

Period

The default period for all metrics in this widget.

virtual Duration Period { get; }
Property Value

Duration

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)

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

ShowUnitsInLabel

Show the metrics units in the label column.

virtual Nullable<bool> ShowUnitsInLabel { 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

Summary

Properties for displaying summary columns.

virtual ITableSummaryProps Summary { get; }
Property Value

ITableSummaryProps

Remarks

Default: - no summary columns are shown

Thresholds

Thresholds for highlighting table cells.

virtual TableThreshold[] Thresholds { get; }
Property Value

TableThreshold[]

Remarks

Default: - No thresholds