@pulumi/awsx
Version:
[](https://github.com/pulumi/pulumi-awsx/actions) [](https://slack.pulumi.com) [![NPM version](https://badge.fur
41 lines • 1.42 kB
TypeScript
import * as aws from "@pulumi/aws";
import * as pulumi from "@pulumi/pulumi";
import { WidgetJson } from "./widgets_json";
/**
* Base type for all [Widget]s that can be placed in a [DashboardGrid].
*
* 1. [RowWidget] and [ColumnWidget] can be used to easily flow other Widgets in a horizontal or
* vertical direction.
*
* 2. [TextWidget] can be used to add text labels easily to the grid.
*
* 3. [SingleNumberMetricWidget] can be used to make a widget that displays information about a
* [Metric] as a single number.
*
* 4. [LineGraphMetricWidget] and [StackedAreaGraphMetricWidget] can be used to display a series
* of metric values as a graph.
*/
export interface Widget {
/**
* The width of the widget in grid units (in a 24-column grid). The default is 6.
*
* Valid Values: 1–24
*
* Type: Integer
*/
width(): number;
/**
* The height of the widget in grid units. The default is 6.
*
* Valid Values: 1–1000
*/
height(): number;
/**
* Converts this widget to an appropriate JSON pojo. The [xOffset] and [yOffset] parameters
* specify where in the final [Dashboard] grid this [Widget] should be placed.
*
* For internal use only.
*/
addWidgetJson(widgetJsons: WidgetJson[], xOffset: number, yOffset: number, region: pulumi.Output<aws.Region>): void;
}
//# sourceMappingURL=widget.d.ts.map