Interface CfnAnalysis.SheetProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAnalysis.SheetProperty.Jsii$Proxy
- Enclosing class:
CfnAnalysis
@Stability(Stable)
public static interface CfnAnalysis.SheetProperty
extends software.amazon.jsii.JsiiSerializable
A sheet , which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight.
Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
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 availabilityStatus; SheetProperty sheetProperty = SheetProperty.builder() .images(List.of(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())) .name("name") .sheetId("sheetId") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnAnalysis.SheetProperty
static final class
An implementation forCfnAnalysis.SheetProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getImages
A list of images on a sheet.- See Also:
-
getName
The name of a sheet.This name is displayed on the sheet's tab in the Amazon QuickSight console.
- See Also:
-
getSheetId
The unique identifier associated with a sheet.- See Also:
-
builder
- Returns:
- a
CfnAnalysis.SheetProperty.Builder
ofCfnAnalysis.SheetProperty
-