Interface CfnAnalysis.CustomContentVisualProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAnalysis.CustomContentVisualProperty.Jsii$Proxy
- Enclosing class:
CfnAnalysis
@Stability(Stable)
public static interface CfnAnalysis.CustomContentVisualProperty
extends software.amazon.jsii.JsiiSerializable
A visual that contains custom content.
For more information, see Using custom visual content in the Amazon Quick Suite User Guide .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;
CustomContentVisualProperty customContentVisualProperty = CustomContentVisualProperty.builder()
.dataSetIdentifier("dataSetIdentifier")
.visualId("visualId")
// the properties below are optional
.actions(List.of(VisualCustomActionProperty.builder()
.actionOperations(List.of(VisualCustomActionOperationProperty.builder()
.filterOperation(CustomActionFilterOperationProperty.builder()
.selectedFieldsConfiguration(FilterOperationSelectedFieldsConfigurationProperty.builder()
.selectedColumns(List.of(ColumnIdentifierProperty.builder()
.columnName("columnName")
.dataSetIdentifier("dataSetIdentifier")
.build()))
.selectedFieldOptions("selectedFieldOptions")
.selectedFields(List.of("selectedFields"))
.build())
.targetVisualsConfiguration(FilterOperationTargetVisualsConfigurationProperty.builder()
.sameSheetTargetVisualConfiguration(SameSheetTargetVisualConfigurationProperty.builder()
.targetVisualOptions("targetVisualOptions")
.targetVisuals(List.of("targetVisuals"))
.build())
.build())
.build())
.navigationOperation(CustomActionNavigationOperationProperty.builder()
.localNavigationConfiguration(LocalNavigationConfigurationProperty.builder()
.targetSheetId("targetSheetId")
.build())
.build())
.setParametersOperation(CustomActionSetParametersOperationProperty.builder()
.parameterValueConfigurations(List.of(SetParameterValueConfigurationProperty.builder()
.destinationParameterName("destinationParameterName")
.value(DestinationParameterValueConfigurationProperty.builder()
.customValuesConfiguration(CustomValuesConfigurationProperty.builder()
.customValues(CustomParameterValuesProperty.builder()
.dateTimeValues(List.of("dateTimeValues"))
.decimalValues(List.of(123))
.integerValues(List.of(123))
.stringValues(List.of("stringValues"))
.build())
// the properties below are optional
.includeNullValue(false)
.build())
.selectAllValueOptions("selectAllValueOptions")
.sourceColumn(ColumnIdentifierProperty.builder()
.columnName("columnName")
.dataSetIdentifier("dataSetIdentifier")
.build())
.sourceField("sourceField")
.sourceParameterName("sourceParameterName")
.build())
.build()))
.build())
.urlOperation(CustomActionURLOperationProperty.builder()
.urlTarget("urlTarget")
.urlTemplate("urlTemplate")
.build())
.build()))
.customActionId("customActionId")
.name("name")
.trigger("trigger")
// the properties below are optional
.status("status")
.build()))
.chartConfiguration(CustomContentConfigurationProperty.builder()
.contentType("contentType")
.contentUrl("contentUrl")
.imageScaling("imageScaling")
.interactions(VisualInteractionOptionsProperty.builder()
.contextMenuOption(ContextMenuOptionProperty.builder()
.availabilityStatus("availabilityStatus")
.build())
.visualMenuOption(VisualMenuOptionProperty.builder()
.availabilityStatus("availabilityStatus")
.build())
.build())
.build())
.subtitle(VisualSubtitleLabelOptionsProperty.builder()
.formatText(LongFormatTextProperty.builder()
.plainText("plainText")
.richText("richText")
.build())
.visibility("visibility")
.build())
.title(VisualTitleLabelOptionsProperty.builder()
.formatText(ShortFormatTextProperty.builder()
.plainText("plainText")
.richText("richText")
.build())
.visibility("visibility")
.build())
.visualContentAltText("visualContentAltText")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnAnalysis.CustomContentVisualPropertystatic final classAn implementation forCfnAnalysis.CustomContentVisualProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectThe list of custom actions that are configured for a visual.default ObjectThe configuration of aCustomContentVisual.The dataset that is used to create the custom content visual.default ObjectThe subtitle that is displayed on the visual.default ObjectgetTitle()The title that is displayed on the visual.default StringThe alt text for the visual.The unique identifier of a visual.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDataSetIdentifier
The dataset that is used to create the custom content visual.You can't create a visual without a dataset.
- See Also:
-
getVisualId
The unique identifier of a visual.This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
- See Also:
-
getActions
The list of custom actions that are configured for a visual.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnAnalysis.VisualCustomActionProperty>- See Also:
-
getChartConfiguration
The configuration of aCustomContentVisual.Returns union: either
IResolvableorCfnAnalysis.CustomContentConfigurationProperty- See Also:
-
getSubtitle
The subtitle that is displayed on the visual.Returns union: either
IResolvableorCfnAnalysis.VisualSubtitleLabelOptionsProperty- See Also:
-
getTitle
The title that is displayed on the visual.Returns union: either
IResolvableorCfnAnalysis.VisualTitleLabelOptionsProperty- See Also:
-
getVisualContentAltText
The alt text for the visual.- See Also:
-
builder
-