VisualCustomAction

A custom action defined on a visual.

In the following list, the required parameters are described first.

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.

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Required: Yes

CustomActionId

The ID of the VisualCustomAction.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: Yes

Name

The name of the VisualCustomAction.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

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.

Type: String

Valid Values: DATA_POINT_CLICK | DATA_POINT_MENU

Required: Yes

Status

The status of the VisualCustomAction.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Contents