Widget

Functional reference for WidgetObject, including its runtime role and the supported settings available in the design environment.

Updated 2 min read
On this page (6 sections)
  1. Functional explanation
  2. Object name
  3. Settings
  4. Position / Size
  5. Border
  6. Visibility

Functional explanation

WidgetObject embeds custom HTML, CSS, and JavaScript. It is intended for advanced custom behavior that cannot be built with the standard objects.

The object is useful when a page needs custom controls, specialized rendering, or embedded logic that is easier to express as HTML than as a fixed design object.

Use WidgetObject only when the standard object set is not sufficient. For common controls and graphics, standard objects are easier to support and troubleshoot.

Object name

Set the object name shown in the widget decorator context.

SettingDescriptionExampleUnits
Object NameName used to identify the Widget object.CustomWidgetPanelText

Settings

Configure the embedded HTML and widget behavior.

SettingDescriptionExampleUnits
HTMLEmbedded HTML content used by the widget.<div>Custom content</div>HTML
ClickableMakes the widget respond to clicks when enabled.trueBoolean
Border ColorBorder color used for the widget.#CED4DAColor
Border WidthBorder width used for the widget.1px
Border RadiusCorner radius of the widget border.4px

Position / Size

Configure the position and size of the Widget object.

SettingDescriptionExampleUnits
TopTop position of the object.100px
LeftLeft position of the object.220px
WidthWidth of the object.320px
HeightHeight of the object.180px
Z-indexLayer order of the object. Higher values appear in front of lower values.10Number

Border

Configure the border styling for the Widget object.

SettingDescriptionExampleUnits
Border ColorBorder color used for the widget.#CED4DAColor
Border Color StatesDynamic border color state rules JSON array.[{"state":"alarm","color":"#dc3545"}]JSON array
Border WidthBorder width used for the widget.1px
Border RadiusCorner radius of the widget border.4px
Border VisibilityExpression controlling whether the border is visible.SYSTEM.UserGroups == "Operators"Expression
Border BlinkExpression or boolean controlling border blinking.PLC1.AlarmActiveBoolean or expression
Border Blink SpeedBlink speed used for the border.500ms
Border Blink OffsetBlink offset used to stagger border blinking between objects.falseBoolean

Visibility

Configure the runtime visibility and blinking behavior for the Widget object.

SettingDescriptionExampleUnits
VisibilityExpression controlling whether the object is visible.PLC1.WidgetVisibleExpression
BlinkExpression or boolean controlling widget blinking.PLC1.AlarmActiveBoolean or expression
Blink SpeedBlink speed used during runtime.500ms
Blink OffsetBlink offset used to stagger blinking between objects.falseBoolean
Something missing or wrong in this article? Contact us