Class: AWSCDK::QuickSight::CfnTemplate::FieldBasedTooltipProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTemplate::FieldBasedTooltipProperty

Defined in:

quick_sight/cfn_template.rb

Overview

The setup for the detailed tooltip.

See Also:

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

Instance Attribute Summary

• #aggregation_visibility ⇒ String^? readonly

  The visibility of Show aggregations .

• #tooltip_fields ⇒ AWSCDK::IResolvable, ... readonly

  The fields configuration in the tooltip.

• #tooltip_title_type ⇒ String^? readonly

  The type for the >tooltip title.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(aggregation_visibility: nil, tooltip_fields: nil, tooltip_title_type: nil) ⇒ FieldBasedTooltipProperty constructor

  A new instance of FieldBasedTooltipProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(aggregation_visibility: nil, tooltip_fields: nil, tooltip_title_type: nil) ⇒ FieldBasedTooltipProperty

Returns a new instance of FieldBasedTooltipProperty.

Parameters:

• aggregation_visibility (String, nil) (defaults to: nil) —

  The visibility of Show aggregations .

• tooltip_fields (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::TooltipItemProperty>, nil) (defaults to: nil) —

  The fields configuration in the tooltip.

• tooltip_title_type (String, nil) (defaults to: nil) —

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

# File 'quick_sight/cfn_template.rb', line 8806

def initialize(aggregation_visibility: nil, tooltip_fields: nil, tooltip_title_type: nil)
  @aggregation_visibility = aggregation_visibility
  Jsii::Type.check_type(@aggregation_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "aggregationVisibility") unless @aggregation_visibility.nil?
  @tooltip_fields = tooltip_fields
  Jsii::Type.check_type(@tooltip_fields, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5Ub29sdGlwSXRlbVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "tooltipFields") unless @tooltip_fields.nil?
  @tooltip_title_type = tooltip_title_type
  Jsii::Type.check_type(@tooltip_title_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tooltipTitleType") unless @tooltip_title_type.nil?
end

Instance Attribute Details

#aggregation_visibility ⇒ String^? (readonly)

The visibility of Show aggregations .

Returns:

• (String, nil)

See Also:

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

# File 'quick_sight/cfn_template.rb', line 8819

def aggregation_visibility
  @aggregation_visibility
end

#tooltip_fields ⇒ AWSCDK::IResolvable, ... (readonly)

The fields configuration in the tooltip.

Returns:

• (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::TooltipItemProperty>, nil)

See Also:

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

# File 'quick_sight/cfn_template.rb', line 8824

def tooltip_fields
  @tooltip_fields
end

#tooltip_title_type ⇒ String^? (readonly)

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.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldbasedtooltip.html#cfn-quicksight-template-fieldbasedtooltip-tooltiptitletype

# File 'quick_sight/cfn_template.rb', line 8832

def tooltip_title_type
  @tooltip_title_type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_template.rb', line 8834

def self.jsii_properties
  {
    :aggregation_visibility => "aggregationVisibility",
    :tooltip_fields => "tooltipFields",
    :tooltip_title_type => "tooltipTitleType",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_template.rb', line 8842

def to_jsii
  result = {}
  result.merge!({
    "aggregationVisibility" => @aggregation_visibility,
    "tooltipFields" => @tooltip_fields,
    "tooltipTitleType" => @tooltip_title_type,
  })
  result.compact
end