Package software.amazon.awscdk.services.quicksight

Interface CfnAnalysis.FieldBasedTooltipProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysis.FieldBasedTooltipProperty.Jsii$Proxy

Enclosing class:

CfnAnalysis

@Stability(Stable)
public static interface CfnAnalysis.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()
                                 .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")
                         .tooltipTarget("tooltipTarget")
                         .visibility("visibility")
                         .build())
                 .fieldTooltipItem(FieldTooltipItemProperty.builder()
                         .fieldId("fieldId")
                         // the properties below are optional
                         .label("label")
                         .tooltipTarget("tooltipTarget")
                         .visibility("visibility")
                         .build())
                 .build()))
         .tooltipTitleType("tooltipTitleType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnalysis.FieldBasedTooltipProperty.Builder	builder()
default String	getAggregationVisibility()	The visibility of Show aggregations .
default Object	getTooltipFields()	The fields configuration in the tooltip.
default String	getTooltipTitleType()	The type for the >tooltip title.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAggregationVisibility

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

The visibility of Show aggregations .

See Also:

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

getTooltipFields

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

The fields configuration in the tooltip.

See Also:

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

getTooltipTitleType

@Stability(Stable)
@Nullable
default String 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.

See Also:

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

builder

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

Returns:

a CfnAnalysis.FieldBasedTooltipProperty.Builder of CfnAnalysis.FieldBasedTooltipProperty