Interface CfnTemplate.SheetImageProperty
- All Superinterfaces:
 software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
 CfnTemplate.SheetImageProperty.Jsii$Proxy
- Enclosing class:
 CfnTemplate
@Stability(Stable)
public static interface CfnTemplate.SheetImageProperty
extends software.amazon.jsii.JsiiSerializable
An image that is located on a sheet.
 
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.*;
 Object visibility;
 SheetImageProperty sheetImageProperty = SheetImageProperty.builder()
         .sheetImageId("sheetImageId")
         .source(SheetImageSourceProperty.builder()
                 .sheetImageStaticFileSource(SheetImageStaticFileSourceProperty.builder()
                         .staticFileId("staticFileId")
                         .build())
                 .build())
         // the properties below are optional
         .actions(List.of(ImageCustomActionProperty.builder()
                 .actionOperations(List.of(ImageCustomActionOperationProperty.builder()
                         .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()))
         .imageContentAltText("imageContentAltText")
         .interactions(ImageInteractionOptionsProperty.builder()
                 .imageMenuOption(ImageMenuOptionProperty.builder()
                         .availabilityStatus("availabilityStatus")
                         .build())
                 .build())
         .scaling(SheetImageScalingConfigurationProperty.builder()
                 .scalingType("scalingType")
                 .build())
         .tooltip(SheetImageTooltipConfigurationProperty.builder()
                 .tooltipText(SheetImageTooltipTextProperty.builder()
                         .plainText("plainText")
                         .build())
                 .visibility(visibility)
                 .build())
         .build();
 
 - See Also:
 
- 
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnTemplate.SheetImagePropertystatic final classAn implementation forCfnTemplate.SheetImageProperty - 
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectA list of custom actions that are configured for an image.default StringThe alt text for the image.default ObjectThe general image interactions setup for an image.default ObjectDetermines how the image is scaled.The ID of the sheet image.The source of the image.default ObjectThe tooltip to be shown when hovering over the image.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson 
- 
Method Details
- 
getSheetImageId
The ID of the sheet image.- See Also:
 
 - 
getSource
The source of the image.Returns union: either
IResolvableorCfnTemplate.SheetImageSourceProperty- See Also:
 
 - 
getActions
A list of custom actions that are configured for an image.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnTemplate.ImageCustomActionProperty>- See Also:
 
 - 
getImageContentAltText
The alt text for the image.- See Also:
 
 - 
getInteractions
The general image interactions setup for an image.Returns union: either
IResolvableorCfnTemplate.ImageInteractionOptionsProperty- See Also:
 
 - 
getScaling
Determines how the image is scaled.Returns union: either
IResolvableorCfnTemplate.SheetImageScalingConfigurationProperty- See Also:
 
 - 
getTooltip
The tooltip to be shown when hovering over the image.Returns union: either
IResolvableorCfnTemplate.SheetImageTooltipConfigurationProperty- See Also:
 
 - 
builder
 
 -