Interface IGraphWidgetProps

Properties for a GraphWidget.

Inherited Members

IMetricWidgetProps.Height

IMetricWidgetProps.Region

IMetricWidgetProps.Title

IMetricWidgetProps.Width

Namespace: Amazon.CDK.AWS.CloudWatch

Assembly: Amazon.CDK.AWS.CloudWatch.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

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.
Statistic	The default statistic to be displayed for each metric.
View	Display this metric.

Properties

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

IHorizontalAnnotation[]

Remarks

Default: - No annotations

LeftYAxis

Left Y axis.

virtual IYAxisProps LeftYAxis { get; }

Property Value

IYAxisProps

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

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)

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

IHorizontalAnnotation[]

Remarks

Default: - No annotations

RightYAxis

Right Y axis.

virtual IYAxisProps RightYAxis { get; }

Property Value

IYAxisProps

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

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

View

Display this metric.

virtual Nullable<GraphWidgetView> View { get; }

Property Value

System.Nullable<GraphWidgetView>

Remarks

Default: TimeSeries