Interface Widget

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.

interface Widget {
    addWidgetJson(widgetJsons, xOffset, yOffset, region): void;
    height(): number;
    width(): number;
}

Implemented by

Methods

addWidgetJson height width

Methods

addWidgetJson

  • addWidgetJson(widgetJsons, xOffset, yOffset, region): void

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

    Parameters

    • widgetJsons: WidgetJson[]
    • xOffset: number
    • yOffset: number
    • region: Output<Region>

    Returns void

height

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

Settings

Member Visibility

Theme

On This Page

addWidgetJsonheightwidth

Generated using TypeDoc