interface VisualCustomActionProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.QuickSight.CfnAnalysis.VisualCustomActionProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_VisualCustomActionProperty |
![]() | software.amazon.awscdk.services.quicksight.CfnAnalysis.VisualCustomActionProperty |
![]() | aws_cdk.aws_quicksight.CfnAnalysis.VisualCustomActionProperty |
![]() | aws-cdk-lib » aws_quicksight » CfnAnalysis » 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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const visualCustomActionProperty: quicksight.CfnAnalysis.VisualCustomActionProperty = {
actionOperations: [{
filterOperation: {
selectedFieldsConfiguration: {
selectedColumns: [{
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
}],
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',
sourceColumn: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
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 |
---|---|---|
action | IResolvable | IResolvable | Visual [] | A list of VisualCustomActionOperations . |
custom | 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
|
Visual
[]
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
.