Transform Editor

This widget can be used to test a transform action. See Transform section in Actions for more details.

Model

{
    "type": "transformeditor",
    "actions": {},
    "completeMsgObject": false,
    "dataSource": {},
    "editorOptions": {},
    "input": {},
    "toolbars": {},
    "transform": {
        "type": "transform",
        "aggregateOne": [
            {}
        ]
    }
}
Field Description

actions

Optional property, used to implement action pipelines for specific trigger events.

completeMsgObject

Set this property to true if the entire input message should be available to the transform logic. By default, this is false

dataSource

Property used to retrieve data from the system

editorOptions

Additional configuration options for the transform editor. The available options can be found here

input

Defines the input message for the transform editor

toolbars

Optional property, used to add, customise or hide toolbars.

transform

Defines the transform logic

Actions

The actions property of the transform editor widget model can be used to implement action pipelines for specific trigger events. The transform editor widget only supports the general widget action hooks, which can be found here.

Receive messages (Send Topics)

The transform editor widget can receive messages from other widgets. This widget only supports the general topics refresh and update.

DataSource

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

The message returned by the data from a dataSource, defined as an object, is determined by the type field if it matches the widget type. If this is not the case, the input and transform fields are checked in the payload and merged into the model. However, if neither of these fields have been defined, then the payload is assigned to input field.

Toolbars

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

Tools

The following tools have a default implementation on the transform editor widget.

Icon Name Description

Format Btn

Format

This tool can be used to format the text in the editor if required.

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.