Class MetricWidget`Abstract`

Base type for widgets that display data from a set of [Metric]s. See [LineGraphMetricWidget], [StackedAreaGraphMetricWidget] and [SingleNumberMetricWidget] as concrete [Widget] instances for displaying [Metric]s.

Hierarchy (view full)

SimpleWidget
- MetricWidget
  - GraphMetricWidget
  - SingleNumberMetricWidget

Index

Constructors

Methods

addWidgetJson computeProperties computeType computeView computeYAxis computedStacked height width

Constructors

constructor

new MetricWidget(metricArgs): MetricWidget
Parameters
- metricArgs: MetricWidgetArgs
Returns MetricWidget
Overrides SimpleWidget.constructor
- Defined in classic/cloudwatch/widgets_simple.ts:291

Methods

addWidgetJson

addWidgetJson(widgetJsons, xOffset, yOffset, region): void
For internal use only.
Parameters
- widgetJsons: WidgetJson[]
- xOffset: number
- yOffset: number
- region: Output<Region>
Returns void
Inherited from SimpleWidget.addWidgetJson
- Defined in classic/cloudwatch/widgets_simple.ts:75

`Protected` computeProperties

computeProperties(region): Input<MetricWidgetPropertiesJson>
Parameters
- region: Output<Region>
Returns Input<MetricWidgetPropertiesJson>
Overrides SimpleWidget.computeProperties
- Defined in classic/cloudwatch/widgets_simple.ts:317

`Protected` computeType

computeType(): Input<"metric">
Returns Input<"metric">
Overrides SimpleWidget.computeType
- Defined in classic/cloudwatch/widgets_simple.ts:315

`Protected` `Abstract` computeView

computeView(): Input<undefined | "timeSeries" | "singleValue">
Returns Input<undefined | "timeSeries" | "singleValue">
- Defined in classic/cloudwatch/widgets_simple.ts:311

`Protected` `Abstract` computeYAxis

computeYAxis(): any
Returns any
- Defined in classic/cloudwatch/widgets_simple.ts:313

`Protected` `Abstract` computedStacked

computedStacked(): Input<undefined | boolean>
Returns Input<undefined | boolean>
- Defined in classic/cloudwatch/widgets_simple.ts:312

height

height(): number
The height of the widget in grid units. The default is 6.

Valid Values: 1–1000

Returns number
Inherited from SimpleWidget.height
- Defined in classic/cloudwatch/widgets_simple.ts:65

width

width(): number
The width of the widget in grid units (in a 24-column grid). The default is 6.

Valid Values: 1–24

Type: Integer

Returns number
Inherited from SimpleWidget.width
- Defined in classic/cloudwatch/widgets_simple.ts:61

Generated using TypeDoc