Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.TooltipOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.TooltipOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.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()
                                         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboard.TooltipOptionsProperty.Builder	A builder for CfnDashboard.TooltipOptionsProperty
static final class	CfnDashboard.TooltipOptionsProperty.Jsii$Proxy	An implementation for CfnDashboard.TooltipOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.TooltipOptionsProperty.Builder	builder()
default Object	getFieldBasedTooltip()	The setup for the detailed tooltip.
default String	getSelectedTooltipType()	The selected type for the tooltip.
default String	getTooltipVisibility()	Determines whether or not the tooltip is visible.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFieldBasedTooltip

@Stability(Stable)
@Nullable
default Object getFieldBasedTooltip()

The setup for the detailed tooltip.

The tooltip setup is always saved. The display type is decided based on the tooltip type.

getSelectedTooltipType

@Stability(Stable)
@Nullable
default String getSelectedTooltipType()

The selected type for the tooltip. Choose one of the following options:.

• BASIC : A basic tooltip.
• DETAILED : A detailed tooltip.

getTooltipVisibility

@Stability(Stable)
@Nullable
default String getTooltipVisibility()

Determines whether or not the tooltip is visible.

builder

@Stability(Stable)
static CfnDashboard.TooltipOptionsProperty.Builder builder()

Returns:

a CfnDashboard.TooltipOptionsProperty.Builder of CfnDashboard.TooltipOptionsProperty