interface TooltipItemProperty

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

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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const tooltipItemProperty: quicksight.CfnTemplate.TooltipItemProperty = {
  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',
  },
};

Properties

Name	Type	Description
columnTooltipItem?	`IResolvable` `\|` `ColumnTooltipItemProperty`	The tooltip item for the columns that are not part of a field well.
fieldTooltipItem?	`IResolvable` `\|` `FieldTooltipItemProperty`	The tooltip item for the fields.

columnTooltipItem?

Type: IResolvable | ColumnTooltipItemProperty (optional)

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

fieldTooltipItem?

Type: IResolvable | FieldTooltipItemProperty (optional)

The tooltip item for the fields.