Package software.amazon.awscdk.services.quicksight

Interface CfnAnalysis.TooltipOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysis.TooltipOptionsProperty.Jsii$Proxy

Enclosing class:

CfnAnalysis

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

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tooltipoptions.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnalysis.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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tooltipoptions.html#cfn-quicksight-analysis-tooltipoptions-fieldbasedtooltip

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tooltipoptions.html#cfn-quicksight-analysis-tooltipoptions-selectedtooltiptype

getTooltipVisibility

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

Determines whether or not the tooltip is visible.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tooltipoptions.html#cfn-quicksight-analysis-tooltipoptions-tooltipvisibility

builder

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

Returns:

a CfnAnalysis.TooltipOptionsProperty.Builder of CfnAnalysis.TooltipOptionsProperty