aws-cdk-lib.aws_quicksight.CfnAnalysis.TooltipItemProperty

TooltipItemProperty Struct

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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.CfnAnalysis.TooltipItemProperty = {
  columnTooltipItem: {
    column: {
      columnName: 'columnName',

      // the properties below are optional
      dataSetIdentifier: 'dataSetIdentifier',
      topicIdentifier: 'topicIdentifier',
    },

    // 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

columnTooltipItemIResolvable | CfnAnalysis.ColumnTooltipItemPropertycolumn_tooltip_itemtyping.Union[IResolvable, ColumnTooltipItemProperty]columnTooltipItemIResolvableColumnTooltipItemIResolvableColumnTooltipIteminterface{}#

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

fieldTooltipItemIResolvable | CfnAnalysis.FieldTooltipItemPropertyfield_tooltip_itemtyping.Union[IResolvable, FieldTooltipItemProperty]fieldTooltipItemIResolvableFieldTooltipItemIResolvableFieldTooltipIteminterface{}#

The tooltip item for the fields.