aws-cdk-lib.aws_quicksight.CfnTemplate.ColumnTooltipItemProperty

ColumnTooltipItemProperty Struct

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

Source

Generated code

Type last changed

v2.157.0 · 10 Sep 2024

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 columnTooltipItemProperty: quicksight.CfnTemplate.ColumnTooltipItemProperty = {
  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',
};

Properties

aggregationIResolvable | CfnTemplate.AggregationFunctionPropertyaggregationtyping.Union[IResolvable, AggregationFunctionProperty]aggregationIResolvableAggregationIResolvableAggregationinterface{}#

The aggregation function of the column tooltip item.

columnIResolvable | CfnTemplate.ColumnIdentifierPropertycolumntyping.Union[IResolvable, ColumnIdentifierProperty]columnIResolvableColumnIResolvableColumninterface{}required#

The target column of the tooltip item.

labelstringlabelstrlabelStringLabelstringLabel*string#

The label of the tooltip item.

tooltipTargetstringtooltip_targetstrtooltipTargetStringTooltipTargetstringTooltipTarget*string#

Determines the target of the column tooltip item in a combo chart visual.

visibilitystringvisibilitystrvisibilityStringVisibilitystringVisibility*string#

The visibility of the tooltip item.