Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.TooltipItemProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.TooltipItemProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.TooltipItemProperty
extends software.amazon.jsii.JsiiSerializable

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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.*;
 TooltipItemProperty tooltipItemProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.TooltipItemProperty.Builder	builder()
default Object	getColumnTooltipItem()	The tooltip item for the columns that are not part of a field well.
default Object	getFieldTooltipItem()	The tooltip item for the fields.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumnTooltipItem

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

The tooltip item for the columns that are not part of a field well.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tooltipitem.html#cfn-quicksight-dashboard-tooltipitem-columntooltipitem

getFieldTooltipItem

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

The tooltip item for the fields.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tooltipitem.html#cfn-quicksight-dashboard-tooltipitem-fieldtooltipitem

builder

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

Returns:

a CfnDashboard.TooltipItemProperty.Builder of CfnDashboard.TooltipItemProperty