aws-cdk-lib.aws_quicksight.CfnAnalysis.FieldBasedTooltipProperty

interface FieldBasedTooltipProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnAnalysis.FieldBasedTooltipProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_FieldBasedTooltipProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnAnalysis.FieldBasedTooltipProperty
Pythonaws_cdk.aws_quicksight.CfnAnalysis.FieldBasedTooltipProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnAnalysis » 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.CfnAnalysis.FieldBasedTooltipProperty = {
  aggregationVisibility: 'aggregationVisibility',
  tooltipFields: [{
    columnTooltipItem: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },

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

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

Properties

NameTypeDescription
aggregationVisibility?stringThe visibility of Show aggregations .
tooltipFields?IResolvable | IResolvable | TooltipItemProperty[]The fields configuration in the tooltip.
tooltipTitleType?stringThe 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.