Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.FieldTooltipItemProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.FieldTooltipItemProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.FieldTooltipItemProperty
extends software.amazon.jsii.JsiiSerializable

The tooltip item for the fields.

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.*;
 FieldTooltipItemProperty fieldTooltipItemProperty = FieldTooltipItemProperty.builder()
         .fieldId("fieldId")
         // the properties below are optional
         .label("label")
         .tooltipTarget("tooltipTarget")
         .visibility("visibility")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.FieldTooltipItemProperty.Builder	builder()
String	getFieldId()	The unique ID of the field that is targeted by the tooltip.
default String	getLabel()	The label of the tooltip item.
default String	getTooltipTarget()	Determines the target of the field tooltip item in a combo chart visual.
default String	getVisibility()	The visibility of the tooltip item.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFieldId

@Stability(Stable)
@NotNull
String getFieldId()

The unique ID of the field that is targeted by the tooltip.

See Also:

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

getLabel

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

The label of the tooltip item.

See Also:

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

getTooltipTarget

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

Determines the target of the field tooltip item in a combo chart visual.

See Also:

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

getVisibility

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

The visibility of the tooltip item.

See Also:

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

builder

@Stability(Stable)
static CfnTemplate.FieldTooltipItemProperty.Builder builder()

Returns:

a CfnTemplate.FieldTooltipItemProperty.Builder of CfnTemplate.FieldTooltipItemProperty