interface FieldBasedTooltipProperty

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

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

Properties

Name	Type	Description
aggregationVisibility?	`string`	The visibility of `Show aggregations` .
tooltipFields?	`IResolvable` `\|` `IResolvable` `\|` `TooltipItemProperty[]`	The fields configuration in the tooltip.
tooltipTitleType?	`string`	The type for the >tooltip title. Choose one of the following options:.

aggregationVisibility?

Type: string (optional)

The visibility of Show aggregations .

tooltipFields?

Type: IResolvable | IResolvable | TooltipItemProperty[] (optional)

The fields configuration in the tooltip.

tooltipTitleType?

Type: string (optional)

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.