Interface CfnTemplate.FieldBasedTooltipProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTemplate.FieldBasedTooltipProperty.Jsii$Proxy
- Enclosing class:
- CfnTemplate
@Stability(Stable)
public static interface CfnTemplate.FieldBasedTooltipProperty
extends software.amazon.jsii.JsiiSerializable
The setup for the detailed 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.*; FieldBasedTooltipProperty fieldBasedTooltipProperty = 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() .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();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTemplate.FieldBasedTooltipProperty
static final class
An implementation forCfnTemplate.FieldBasedTooltipProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAggregationVisibility
The visibility ofShow aggregations
. -
getTooltipFields
The fields configuration in the tooltip. -
getTooltipTitleType
The type for the >tooltip title. Choose one of the following options:.NONE
: Doesn't use the primary value as the title.PRIMARY_VALUE
: Uses primary value as the title.
-
builder
-