Interface CfnTemplate.EmptyVisualProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTemplate.EmptyVisualProperty.Jsii$Proxy
- Enclosing class:
CfnTemplate
@Stability(Stable)
public static interface CfnTemplate.EmptyVisualProperty
extends software.amazon.jsii.JsiiSerializable
An empty visual.
Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Amazon QuickSight console is considered an EmptyVisual
until a visual type is selected.
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.*; EmptyVisualProperty emptyVisualProperty = EmptyVisualProperty.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())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTemplate.EmptyVisualProperty
static final class
An implementation forCfnTemplate.EmptyVisualProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDataSetIdentifier
The data set that is used in the empty visual.Every visual requires a dataset to render.
- 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.- See Also:
-
builder
-