Class ImageWidgetDefinition

The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards.

Hierarchy

  • ImageWidgetDefinition

Constructors

constructor

Properties

additionalProperties? hasBackground? hasBorder? horizontalAlign? margin? sizing? type url urlDarkTheme? verticalAlign?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional hasBackground

hasBackground?: boolean

Whether to display a background or not.

Optional hasBorder

hasBorder?: boolean

Whether to display a border or not.

Optional horizontalAlign

horizontalAlign?: WidgetHorizontalAlign

Horizontal alignment.

Optional margin

margin?: WidgetMargin

Size of the margins around the image. Note: small and large values are deprecated.

Optional sizing

sizing?: WidgetImageSizing

How to size the image on the widget. The values are based on the image object-fit CSS properties. Note: zoom, fit and center values are deprecated.

type

type: ImageWidgetDefinitionType

Type of the image widget.

url

url: string

URL of the image.

Optional urlDarkTheme

urlDarkTheme?: string

URL of the image in dark mode.

Optional verticalAlign

verticalAlign?: WidgetVerticalAlign

Vertical alignment.

Settings

Member Visibility

Theme

Generated using TypeDoc