Class EmbeddedAppWidgetDefinition

The embedded app widget displays an App Builder app on a dashboard. Exactly one of app_id or template_id must be provided; they cannot be provided together.

Hierarchy

  • EmbeddedAppWidgetDefinition

Constructors

constructor

Properties

appId? customLinks? description? inputs? templateId? time? title? titleAlign? titleSize? type

Constructors

constructor

Properties

Optional appId

appId?: string

UUID of the App Builder app to embed.

Optional customLinks

customLinks?: WidgetCustomLink[]

List of custom links.

Optional description

description?: string

The description of the widget.

Optional inputs

inputs?: EmbeddedAppWidgetInput[]

Inputs passed to the embedded app.

Optional templateId

templateId?: string

ID of the built-in app template to embed.

Optional time

time?: WidgetTime

Time setting for the widget.

Optional title

title?: string

Title of the widget.

Optional titleAlign

titleAlign?: WidgetTextAlign

How to align the text on the widget.

Optional titleSize

titleSize?: string

Size of the title.

type

type: EmbeddedAppWidgetDefinitionType

Type of the embedded app widget.

Settings

Member Visibility

Theme

Generated using TypeDoc