Interface CfnTemplate.TooltipOptionsProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTemplate.TooltipOptionsProperty.Jsii$Proxy
- Enclosing class:
CfnTemplate
@Stability(Stable)
public static interface CfnTemplate.TooltipOptionsProperty
extends software.amazon.jsii.JsiiSerializable
The display options for the visual tooltip.
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.*; TooltipOptionsProperty tooltipOptionsProperty = TooltipOptionsProperty.builder() .fieldBasedTooltip(FieldBasedTooltipProperty.builder() .aggregationVisibility("aggregationVisibility") .tooltipFields(List.of(TooltipItemProperty.builder() .columnTooltipItem(ColumnTooltipItemProperty.builder() .column(ColumnIdentifierProperty.builder() .columnName("columnName") .dataSetIdentifier("dataSetIdentifier") .build()) // the properties below are optional .aggregation(AggregationFunctionProperty.builder() .attributeAggregationFunction(AttributeAggregationFunctionProperty.builder() .simpleAttributeAggregation("simpleAttributeAggregation") .valueForMultipleValues("valueForMultipleValues") .build()) .categoricalAggregationFunction("categoricalAggregationFunction") .dateAggregationFunction("dateAggregationFunction") .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder() .percentileAggregation(PercentileAggregationProperty.builder() .percentileValue(123) .build()) .simpleNumericalAggregation("simpleNumericalAggregation") .build()) .build()) .label("label") .visibility("visibility") .build()) .fieldTooltipItem(FieldTooltipItemProperty.builder() .fieldId("fieldId") // the properties below are optional .label("label") .visibility("visibility") .build()) .build())) .tooltipTitleType("tooltipTitleType") .build()) .selectedTooltipType("selectedTooltipType") .tooltipVisibility("tooltipVisibility") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTemplate.TooltipOptionsProperty
static final class
An implementation forCfnTemplate.TooltipOptionsProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getFieldBasedTooltip
The setup for the detailed tooltip.The tooltip setup is always saved. The display type is decided based on the tooltip type.
- See Also:
-
getSelectedTooltipType
The selected type for the tooltip. Choose one of the following options:.BASIC
: A basic tooltip.DETAILED
: A detailed tooltip.
- See Also:
-
getTooltipVisibility
Determines whether or not the tooltip is visible.- See Also:
-
builder
-