interface VisualCustomActionProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTemplate.VisualCustomActionProperty
Java	software.amazon.awscdk.services.quicksight.CfnTemplate.VisualCustomActionProperty
Python	aws_cdk.aws_quicksight.CfnTemplate.VisualCustomActionProperty
TypeScript	@aws-cdk/aws-quicksight » CfnTemplate » VisualCustomActionProperty

A custom action defined on a visual.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const visualCustomActionProperty: quicksight.CfnTemplate.VisualCustomActionProperty = {
  actionOperations: [{
    filterOperation: {
      selectedFieldsConfiguration: {
        selectedFieldOptions: 'selectedFieldOptions',
        selectedFields: ['selectedFields'],
      },
      targetVisualsConfiguration: {
        sameSheetTargetVisualConfiguration: {
          targetVisualOptions: 'targetVisualOptions',
          targetVisuals: ['targetVisuals'],
        },
      },
    },
    navigationOperation: {
      localNavigationConfiguration: {
        targetSheetId: 'targetSheetId',
      },
    },
    setParametersOperation: {
      parameterValueConfigurations: [{
        destinationParameterName: 'destinationParameterName',
        value: {
          customValuesConfiguration: {
            customValues: {
              dateTimeValues: ['dateTimeValues'],
              decimalValues: [123],
              integerValues: [123],
              stringValues: ['stringValues'],
            },

            // the properties below are optional
            includeNullValue: false,
          },
          selectAllValueOptions: 'selectAllValueOptions',
          sourceField: 'sourceField',
          sourceParameterName: 'sourceParameterName',
        },
      }],
    },
    urlOperation: {
      urlTarget: 'urlTarget',
      urlTemplate: 'urlTemplate',
    },
  }],
  customActionId: 'customActionId',
  name: 'name',
  trigger: 'trigger',

  // the properties below are optional
  status: 'status',
};

Properties

Name	Type	Description
actionOperations	IResolvable | IResolvable | VisualCustomActionOperationProperty[]	A list of VisualCustomActionOperations .
customActionId	string	The ID of the VisualCustomAction .
name	string	The name of the VisualCustomAction .
trigger	string	The trigger of the VisualCustomAction .
status?	string	The status of the VisualCustomAction .

---

actionOperations

Type: IResolvable | IResolvable | VisualCustomActionOperationProperty[]

A list of VisualCustomActionOperations .

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

---

customActionId

Type: string

The ID of the VisualCustomAction .

---

name

Type: string

The name of the VisualCustomAction .

---

trigger

Type: string

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.

---

status?

Type: string (optional)

The status of the VisualCustomAction .