Actions and events

<< 点击显示目录 >>

主页  mappView帮助助手 > mapp View帮助信息 > Widgets  > Data  > AlarmLine  > AlarmLine  >

Actions and events

The following section describes the possible actions and events for the widget.

Actions

Name

Description

Arguments

Result

SetVisible

Controls the visibility of the widget.

value: Boolean

Visible if the value is true. Otherwise, invisible.

 

SetEnable

Controls the usability of the widget.

value: Boolean

Enabled if the value is true. Otherwise, disabled.

 

SetStyle

Sets a predefined style for the widget.

value: StyleReference

 

ShowTooltip

Mode "Tooltip" can be enabled using this action. When enabled, a tooltip indicator appears inside the widget. For this, a text must be configured in property "Tooltip". This text is displayed when the indicator is selected. Any other operation of a widget terminates mode "Tooltip".

 

 

ShowAlarmByInstanceId

Displays the alarm in the widget whose instance ID is specified as an argument. An empty character string resets the selection.

value: UInteger

 

ShowAlarmByName

Displays the alarm in the widget whose name is specified as an argument. An empty character string resets the selection.

value: String

 

ShowAlarmByCode

Displays the alarm in the widget whose code is specified as an argument. An empty character string resets the selection.

value: UInteger

 

ShowDefault

Resets the values set by actions ShowAlarmByCode, -Id or -Name.

Only the alarms that match the set filterConfiguration and are sorted according to property "sortOrder" are included.

 

 

Acknowledge

Confirms the alarm displayed in widget "AlarmLine".

 

 

OpenConfiguration

Opens a dialog box for configuring the filtering.

For more information about this, see the use cases.

type: MappTableConfigurationType

type defines which type of configuration dialog box is opened.

Types "Filtering" and "Styling" are currently supported.

 

ShowFirst

Displays the first alarm based on the selected criteria, which can be set using the configuration dialog box.

 

result: Boolean

ShowLast

Displays the last alarm based on the selected criteria, which can be set using the configuration dialog box.

 

result: Boolean

ShowNext

Displays the next alarm based on the selected criteria, which can be set using the configuration dialog box.

Return value result = true if another alarm is available; result = false if there is no other alarm.

 

result: Boolean

ShowPrevious

Displays the previous alarm based on the selected criteria, which can be set using the configuration dialog box.

Return value result = true if another alarm is available; result = false if there is no other alarm.

 

result: Boolean

Focus

Sets the focus to the widget when keyboard operation is enabled.

 

 

Table: Actions

Events

Name

Description

Arguments

Click

Triggered when clicking on the widget.

origin: String

"origin" contains the ID of the widget that triggers the click event.

horizontalPos: String

horizontalPos contains the horizontal position of event "Click" in pixels (e.g. 10px starting from the viewport).

verticalPos: String

verticalPos contains the vertical position of the click event in pixels (e.g. 10px starting from viewport).

DisabledClick

Triggered when clicking on the disabled widget.

origin: String

"origin" contains the ID of the widget that triggers the click event.

hasPermission: Boolean

"hasPermission" defines whether the current user has the necessary rights to access it.

horizontalPos: String

horizontalPos contains the horizontal position of the DisabledClick event in pixels (e.g. 10px starting from viewport).

verticalPos: String

verticalPos contains the vertical position of the DisabledClick event in pixels (e.g. 10px starting from viewport).

EnableChanged

Triggered when the usability of the widget is changed. This can be changed using various options:

1) Using property enable (binding or via widget action SetEnable)

2) Using property permissionOperate

3) Using usability properties (enable, permissionOperate, OPC UA variable) of the surrounding container widget

4) Using a bound OPC UA variable with write permissions that have been changed.

value: Boolean

"value" defines the usability of the widget. If true is returned, the widget can be used; if false, it cannot be used.

VisibleChanged

Triggers when the visibility of the widget is changed. This can be changed using various options:

1) Using property visible (binding or via widget action SetVisible)

2) Using property permissionView

3) Using the visibility properties (visible, permissionView) of the surrounding container widget

value: Boolean

"value" defines the visibility of the widget. If true is returned, the widget is displayed; if false, it is not displayed.

OnError

Triggered if a communication error with the mapp component occurs.

result: Integer

"result" returns the error number of the mapp component.

ItemClick

Triggered when clicking on the displayed alarm.

code: Integer

Contains the alarm code of the entry.

instanceID:Integer

Contains the instance ID of the entry.

message: String

Contains the alarm notification of the entry.

name: String

Contains the alarm name of the entry.

scope: String

Contains the alarm scope of the entry.

severity: Integer

Contains the severity of the alarm.

oldState: Integer

Contains the old alarm state of the entry.

newState: Integer

Contains the new alarm state of the entry.

timestamp: String

Contains the timestamp of the alarm.

additionalInfo1: String

Contains the first additional information of the entry.

additionalInfo2: String

Contains the second additional information of the entry.

category: String

Contains the category to which the alarm belongs.

horizontalPos: String

horizontalPos contains the horizontal position of the this event in pixels (e.g. 10px starting from viewport).

verticalPos: String

verticalPos contains the vertical position of the this event in pixels (e.g. 10px starting from viewport).

ItemDoubleClick

Triggered when double-clicking on the displayed alarm.

code: Integer

Contains the alarm code of the entry.

instanceID:Integer

Contains the instance ID of the entry.

message: String

Contains the alarm notification of the entry.

name: String

Contains the alarm name of the entry.

scope: String

Contains the alarm scope of the entry.

severity: Integer

Contains the severity of the alarm.

oldState: Integer

Contains the old alarm state of the entry.

newState: Integer

Contains the new alarm state of the entry.

timestamp: String

Contains the timestamp of the alarm.

additionalInfo1: String

Contains the first additional information of the entry.

additionalInfo2: String

Contains the second additional information of the entry.

category: String

Contains the category to which the alarm belongs.

horizontalPos: String

horizontalPos contains the horizontal position of the this event in pixels (e.g. 10px starting from viewport).

verticalPos: String

verticalPos contains the vertical position of the this event in pixels (e.g. 10px starting from viewport).

AlarmChanged

Triggered when the displayed alarm differs from the previous displayed alarm.

code: Integer

Contains the alarm code of the entry.

instanceID:Integer

Contains the instance ID of the entry.

message: String

Contains the alarm notification of the entry.

name: String

Contains the alarm name of the entry.

scope: String

Contains the alarm scope of the entry.

severity: Integer

Contains the severity of the alarm.

oldState: Integer

Contains the old alarm state of the entry.

newState: Integer

Contains the new alarm state of the entry.

timestamp: String

Contains the timestamp of the alarm.

additionalInfo1: String

Contains the first additional information of the entry.

additionalInfo2: String

Contains the second additional information of the entry.

category: String

Contains the category to which the alarm belongs.

horizontalPos: String

horizontalPos contains the horizontal position of the this event in pixels (e.g. 10px starting from viewport).

verticalPos: String

verticalPos contains the vertical position of the this event in pixels (e.g. 10px starting from viewport).

OnDragEnter

Triggers when a dragged widget is moved over the target widget.

widgetId: String

"widgetId" contains the ID of the widget that performed the drag operation.

contentId: String

"contentId" contains the ID of the piece of content whose widget performed the drag operation.

OnDragLeave

Triggers when a dragged widget is dragged away from the target widget.

widgetId: String

"widgetId" contains the ID of the widget that performed the drag operation.

contentId: String

"contentId" contains the ID of the piece of content whose widget performed the drag operation.

OnDrop

Triggers when a dragged widget is released on the target widget. For the definition of drag-and-drop and an explanation of how these events can be used, see here.

widgetId: String

"widgetId" contains the ID of the widget that performed the drag operation.

contentId: String

"contentId" contains the ID of the piece of content whose widget performed the drag operation.

FocusIn

Triggered when a widget gets the focus.

 

FocusOut

Triggered when a widget loses focus.

 

Table: Events