IFrame

This widget can be used to show images or videos.

Model

{
    "type": "iframe",
    "actions": {},
    "dataSource": {},
    "iframeOptions": {
        "allowFullScreen": true
    },
    "toolbars": {},
    "url": ""
}
Field Description

actions

Optional property used to implement action pipelines for selected trigger events. See the actions section in the widget documentation for more details.

dataSource

Optional property used to retrieve data from the system

iframeOptions

Any valid iframe attributes can be added to the model. See the full list of attributes here: The Inline Frame element

toolbars

Add, customise or hide toolbars. See the toolbars section below.

url

Parameter containing a URL as a string. This should be the location of the webpage, image, document or video to be shown in the iframe.

DataSource

Refer to the generic widget page for a description of the general principles governing the treatment of data retrieved from a dataSource.

If the dataSource property is defined as an object, the message returned by the data is determined by the type field if it matches the widget type. However, if the type field is omitted from the dataSource or does not match, then the url and iframeOptions are checked in the payload and merged into the model.

Receive messages (Send Topics)

The IFrame’s content can be reloaded by sending it a message with the topic set to reload. This options is however being deprecated, since it has been superseded by the more generic update topic which is supported by all widgets.

{
    "type": "send",
    "to": "iframe",
    "message": {
        "topic": "update"
    }
}

Toolbars

The IFrame supports multiple custom toolbars. For information on configuring custom toolbars, see the toolbars section in the widget documentation.

Tools

Icon Name Description

Refresh Btn

Refresh

Refreshes the widget

Spacer

This tool is used to specify the spacing between tools in the widget toolbar. It can be customised using the style and styleByTheme properties.