interface TooltipOptionsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDashboard.TooltipOptionsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_TooltipOptionsProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnDashboard.TooltipOptionsProperty`
Python	`aws_cdk.aws_quicksight.CfnDashboard.TooltipOptionsProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnDashboard` » `TooltipOptionsProperty`

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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const tooltipOptionsProperty: quicksight.CfnDashboard.TooltipOptionsProperty = {
  fieldBasedTooltip: {
    aggregationVisibility: 'aggregationVisibility',
    tooltipFields: [{
      columnTooltipItem: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },

        // the properties below are optional
        aggregation: {
          attributeAggregationFunction: {
            simpleAttributeAggregation: 'simpleAttributeAggregation',
            valueForMultipleValues: 'valueForMultipleValues',
          },
          categoricalAggregationFunction: 'categoricalAggregationFunction',
          dateAggregationFunction: 'dateAggregationFunction',
          numericalAggregationFunction: {
            percentileAggregation: {
              percentileValue: 123,
            },
            simpleNumericalAggregation: 'simpleNumericalAggregation',
          },
        },
        label: 'label',
        tooltipTarget: 'tooltipTarget',
        visibility: 'visibility',
      },
      fieldTooltipItem: {
        fieldId: 'fieldId',

        // the properties below are optional
        label: 'label',
        tooltipTarget: 'tooltipTarget',
        visibility: 'visibility',
      },
    }],
    tooltipTitleType: 'tooltipTitleType',
  },
  selectedTooltipType: 'selectedTooltipType',
  tooltipVisibility: 'tooltipVisibility',
};

Properties

Name	Type	Description
fieldBasedTooltip?	`IResolvable` `\|` `FieldBasedTooltipProperty`	The setup for the detailed tooltip.
selectedTooltipType?	`string`	The selected type for the tooltip. Choose one of the following options:.
tooltipVisibility?	`string`	Determines whether or not the tooltip is visible.

fieldBasedTooltip?

Type: IResolvable | FieldBasedTooltipProperty (optional)

The setup for the detailed tooltip.

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

selectedTooltipType?

Type: string (optional)

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

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

tooltipVisibility?

Type: string (optional)

Determines whether or not the tooltip is visible.