Property Editor

The Property Editor widget is designed to edit properties of objects in the system.

Model

The following properties can be defined for the Property Editor widget. The table below contains more information about these properties.

{
    "type": "propertyeditor",
    "actions": {},
    "blackList": [],
    "captionBar": {},
    "compact": false,
    "dataSource": {},
    "dragSource": {},
    "dropTarget": {},
    "id": "propertyEditorWidgetID",
    "layout": {},
    "name": "propertyEditor",
    "objspec": "",
    "options": {},
    "toolbars": {},
    "whitelist": []
}
Name Description

type

Widget type, in this case "propertyeditor"

actions

Property used to configure action pipelines for specific trigger events. See the actions section below.

blackList

Optional configuration to exclude specific properties from the Property Editor.

captionBar

Property used to configure the widget caption bar. Set this property to false to hide the caption bar for the Property Editor widget. Default is true.

dataSource

Property to configure an optional datasource from which the data or widget model can be loaded. See the datasource section below for more details.

dragSource

Optional property used to allow dragging of information from the widget. See here for more details on configuring the widget as a drag-source.

dropTarget

Optional property used to handle drops from a drag-source. For more information on configuring the widget as a drop-target, see here.

id

Unique widget identifier, can be customised but must be unique in compilation.

layout

Layout properties to configure the size and position of the widget.

name

Optional property to define a name for the widget, shown in the widget caption bar if it is enabled.

objspec

Path to an object in the system or object ID.

options

Configurable properties including the refreshInterval and styling options for the widget.

toolbars

Property used to add, edit or hide widget toolbars. See the toolbars section below.

whiteList

Optional configuration to include only specific properties in the Property Editor widget.

Actions

The actions property in the Property Editor widget model is used to configure action pipelines for specific trigger events. Both lifecycle and action hooks can contain a single action or a series of multiple actions.

The Property Editor widget supports the general lifecycle hooks does not support any additional action hooks.

Blacklist

The blackList property is used to exclude certain properties from the Property Editor widget.

{
    "blackList": []
}

DataSource

The dataSource property can be used to load data from the system or to initialise the model configuration of the Property Editor widget. Information regarding the general principles governing the treatment of information returned by the dataSource can be found here.

Toolbars

The toolbars property is used to add, customise and hide toolbars for the Property Editor widget. This widget supports multiple toolbars. For more details on configuring toolbars, see here.

Tools

The following tools have a defualt implementation for the Property Editor widget.

Icon Tool Name Type SubType Description

Apply Btn

Apply

button

apply

Applies changes made in the Property Editor widget to the selected object

Discard Btn

Discard

button

discard

Discards any unsaved changes in the Property Editor.

Edit Capabilities Btn

Edit Capabilities

property-tool

edit-capabilities

Opens a dialog to edit the capabilities of the object.

Refresh Btn

Refresh

button

refresh

Refreshes the widget

Spacer

spacer

Defines the spacing between tools on the toolbar.

Whitelist

The whiteList property is used to include only specific properties in the Property Editor widget.

{
    "whiteList": []
}

Receive Messages (Send Topics)

The Property Editor widget can receive messages from other widgets. In addition to the generic send topics refresh and update, the Property Editor widget also supports the following topic:

setObjSpec

The setObjSpec topic can be used to define the object spec or path for the object to be displayed in the Property Editor widget.

{
    "type": "send",
    "to": "propertyEditor",
    "message": {
        "topic": "setObjSpec",
        "payload": {
            "objspec": "/"
        }
    }
}

The payload can contain any one of the four following fields:

Name Description

i

Numeric Object ID

objspec

Object path or ID

p

Path to object or property

path

Path to object or property