Actions and events

<< 点击显示目录 >>

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

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

 

Acknowledge

Confirms the selected alarm.

 

 

AcknowledgeAll

Confirms all alarms.

 

 

OpenConfiguration

Opens a dialog box for configuring filtering, sorting and styling. For more information about this, see the use cases.

type: MappTableConfigurationType

type defines which type of configuration dialog box is opened.

 

GoToPage

Navigates to the page specified as the index in the argument. If the page is not available, value false is returned.

For information about creating external navigation, see here.

value: Integer

result: Boolean

GoToFirstPage

Navigates to the first page. If the page is not available, value false is returned.

 

result: Boolean

GoToLastPage

Navigates to the last page. If the page is not available, value false is returned.

 

result: Boolean

GoToNextPage

Navigates to the next page. If the page is not available, value false is returned.

 

result: Boolean

GoToPreviousPage

Navigates to the previous page. If the page is not available, value false is returned.

 

result: Boolean

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".

 

 

SelectAlarmById

Selects the alarm with the specified instance ID of an entry.

This can be used in combination with widget "AlarmLine" where the instance ID of an alarm can be retrieved.

This action does not trigger an ItemClick event.

instanceID:UInteger

instanceID defines which entry of widget "AlarmList" is selected.

 

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 a list entry.

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.

state: Integer

Contains the 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 a list entry.

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.

state: Integer

Contains the 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).

FirstPageNumber

Triggered on every page change and returns the following arguments.

Arguments

pageNumber = Number of the first page

pageText = Number of the first page as text

show = False if the first page is selected

select = 1 if the first page is currently displayed

pageNumber: Integer

pageText: String

show: Boolean

select: Integer

PreviousPageNumber

Triggered on every page change and returns the following arguments.

Arguments

pageNumber = Number of the previous page starting from the currently displayed page.

pageText = Number of the previous page as text (e.g. "1" if 2 is currently displayed)

show = True if at least one page is displayed in the list

select = 1 if the first page is currently displayed

pageNumber: Integer

pageText: String

show: Boolean

select: Integer

CurrentPageNumber

Triggered on every page change and returns the following arguments.

Arguments

pageNumber = Number of the current page

pageText = Number of the current page as text (e.g. "2" if page 2 is currently displayed)

show = True if at least 2 pages are displayed in the list

select = 1 if the first or last page is not currently displayed

pageAlternativeNumber = Number of the current page, but will never be below 2 or above the maximum number of pages minus 1

pageAlternativeText = Number of the current page as text, but will never be below 2 or above the maximum number of pages minus 1

If 3 buttons are used, for example pageAlternativeNumber is used in the middle since the button for the 1st page is before it and the 3rd button is for the last page.

tw_pagealternativenumber

pageNumber: Integer

pageText: String

show: Boolean

select: Integer

pageAlternativeNumber:Integer

pageAlternativeText: String

NextPageNumber

Triggered on every page change and returns the following arguments.

Arguments

pageNumber = Number of the next page starting from the current page.

pageText = Number of the next page as text (e.g. "3" if 2 is the current page)

show = True if at least three pages are displayed

select = 1 if the last page is currently displayed

pageNumber: Integer

pageText: String

show: Boolean

select: Integer

LastPageNumber

Triggered on every page change and returns the following arguments.

Arguments

pageNumber = Number of the last page

pageText = Number of the last page as text

show = False if the last page is displayed

select = 1 if the last page is currently displayed

pageNumber: Integer

pageText: String

show: Boolean

select: Integer

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