Class CfnDashboard.FieldBasedTooltipProperty

The setup for the detailed tooltip.

Inheritance

object

CfnDashboard.FieldBasedTooltipProperty

Implements

CfnDashboard.IFieldBasedTooltipProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.QuickSight

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDashboard.FieldBasedTooltipProperty : CfnDashboard.IFieldBasedTooltipProperty

Syntax (vb)

Public Class CfnDashboard.FieldBasedTooltipProperty Implements CfnDashboard.IFieldBasedTooltipProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldbasedtooltip.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.QuickSight;

             var fieldBasedTooltipProperty = new FieldBasedTooltipProperty {
                 AggregationVisibility = "aggregationVisibility",
                 TooltipFields = new [] { new TooltipItemProperty {
                     ColumnTooltipItem = new ColumnTooltipItemProperty {
                         Column = new ColumnIdentifierProperty {
                             ColumnName = "columnName",
                             DataSetIdentifier = "dataSetIdentifier"
                         },

                         // the properties below are optional
                         Aggregation = new AggregationFunctionProperty {
                             AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
                                 SimpleAttributeAggregation = "simpleAttributeAggregation",
                                 ValueForMultipleValues = "valueForMultipleValues"
                             },
                             CategoricalAggregationFunction = "categoricalAggregationFunction",
                             DateAggregationFunction = "dateAggregationFunction",
                             NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
                                 PercentileAggregation = new PercentileAggregationProperty {
                                     PercentileValue = 123
                                 },
                                 SimpleNumericalAggregation = "simpleNumericalAggregation"
                             }
                         },
                         Label = "label",
                         TooltipTarget = "tooltipTarget",
                         Visibility = "visibility"
                     },
                     FieldTooltipItem = new FieldTooltipItemProperty {
                         FieldId = "fieldId",

                         // the properties below are optional
                         Label = "label",
                         TooltipTarget = "tooltipTarget",
                         Visibility = "visibility"
                     }
                 } },
                 TooltipTitleType = "tooltipTitleType"
             };

Synopsis

Constructors

FieldBasedTooltipProperty()

The setup for the detailed tooltip.

Properties

AggregationVisibility	The visibility of `Show aggregations` .
TooltipFields	The fields configuration in the tooltip.
TooltipTitleType	The type for the >tooltip title. Choose one of the following options:.

Constructors

FieldBasedTooltipProperty()

The setup for the detailed tooltip.

public FieldBasedTooltipProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldbasedtooltip.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.QuickSight;

             var fieldBasedTooltipProperty = new FieldBasedTooltipProperty {
                 AggregationVisibility = "aggregationVisibility",
                 TooltipFields = new [] { new TooltipItemProperty {
                     ColumnTooltipItem = new ColumnTooltipItemProperty {
                         Column = new ColumnIdentifierProperty {
                             ColumnName = "columnName",
                             DataSetIdentifier = "dataSetIdentifier"
                         },

                         // the properties below are optional
                         Aggregation = new AggregationFunctionProperty {
                             AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
                                 SimpleAttributeAggregation = "simpleAttributeAggregation",
                                 ValueForMultipleValues = "valueForMultipleValues"
                             },
                             CategoricalAggregationFunction = "categoricalAggregationFunction",
                             DateAggregationFunction = "dateAggregationFunction",
                             NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
                                 PercentileAggregation = new PercentileAggregationProperty {
                                     PercentileValue = 123
                                 },
                                 SimpleNumericalAggregation = "simpleNumericalAggregation"
                             }
                         },
                         Label = "label",
                         TooltipTarget = "tooltipTarget",
                         Visibility = "visibility"
                     },
                     FieldTooltipItem = new FieldTooltipItemProperty {
                         FieldId = "fieldId",

                         // the properties below are optional
                         Label = "label",
                         TooltipTarget = "tooltipTarget",
                         Visibility = "visibility"
                     }
                 } },
                 TooltipTitleType = "tooltipTitleType"
             };

Properties

AggregationVisibility

The visibility of Show aggregations .

public string? AggregationVisibility { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldbasedtooltip.html#cfn-quicksight-dashboard-fieldbasedtooltip-aggregationvisibility

TooltipFields

The fields configuration in the tooltip.

public object? TooltipFields { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldbasedtooltip.html#cfn-quicksight-dashboard-fieldbasedtooltip-tooltipfields

TooltipTitleType

The type for the >tooltip title. Choose one of the following options:.

public string? TooltipTitleType { get; set; }