Skip to content

/AWS1/CL_QSTVISUALCUSTOMACTION

A custom action defined on a visual.

CONSTRUCTOR

IMPORTING

Required arguments:

IV_CUSTOMACTIONID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

The ID of the VisualCustomAction.

IV_NAME TYPE /AWS1/QSTVISUALCUSTACTIONNAME /AWS1/QSTVISUALCUSTACTIONNAME

The name of the VisualCustomAction.

IV_TRIGGER TYPE /AWS1/QSTVISUALCUSTACTTRIGGER /AWS1/QSTVISUALCUSTACTTRIGGER

The trigger of the VisualCustomAction.

Valid values are defined as follows:

  • DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

  • DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

IT_ACTIONOPERATIONS TYPE /AWS1/CL_QSTVISUALCUSTACTIONOP=>TT_VISUALCUSTOMACTIONOPLIST TT_VISUALCUSTOMACTIONOPLIST

A list of VisualCustomActionOperations.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Optional arguments:

IV_STATUS TYPE /AWS1/QSTWIDGETSTATUS /AWS1/QSTWIDGETSTATUS

The status of the VisualCustomAction.


Queryable Attributes

CustomActionId

The ID of the VisualCustomAction.

Accessible with the following methods

Method Description
GET_CUSTOMACTIONID() Getter for CUSTOMACTIONID, with configurable default
ASK_CUSTOMACTIONID() Getter for CUSTOMACTIONID w/ exceptions if field has no valu
HAS_CUSTOMACTIONID() Determine if CUSTOMACTIONID has a value

Name

The name of the VisualCustomAction.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

Status

The status of the VisualCustomAction.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

Trigger

The trigger of the VisualCustomAction.

Valid values are defined as follows:

  • DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

  • DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

Accessible with the following methods

Method Description
GET_TRIGGER() Getter for TRIGGER, with configurable default
ASK_TRIGGER() Getter for TRIGGER w/ exceptions if field has no value
HAS_TRIGGER() Determine if TRIGGER has a value

ActionOperations

A list of VisualCustomActionOperations.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Accessible with the following methods

Method Description
GET_ACTIONOPERATIONS() Getter for ACTIONOPERATIONS, with configurable default
ASK_ACTIONOPERATIONS() Getter for ACTIONOPERATIONS w/ exceptions if field has no va
HAS_ACTIONOPERATIONS() Determine if ACTIONOPERATIONS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_VISUALCUSTOMACTIONLIST

TYPES TT_VISUALCUSTOMACTIONLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_QSTVISUALCUSTOMACTION WITH DEFAULT KEY
.