Class: AWSCDK::QuickSight::CfnTemplate::TooltipOptionsProperty

Inherits:

Jsii::Struct

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

Defined in:

quick_sight/cfn_template.rb

Overview

The display options for the visual tooltip.

See Also:

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

Instance Attribute Summary

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

  The setup for the detailed tooltip.

• #selected_tooltip_type ⇒ String^? readonly

  The selected type for the tooltip.

• #tooltip_visibility ⇒ String^? readonly

  Determines whether or not the tooltip is visible.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(field_based_tooltip: nil, selected_tooltip_type: nil, tooltip_visibility: nil) ⇒ TooltipOptionsProperty constructor

  A new instance of TooltipOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(field_based_tooltip: nil, selected_tooltip_type: nil, tooltip_visibility: nil) ⇒ TooltipOptionsProperty

Returns a new instance of TooltipOptionsProperty.

Parameters:

• field_based_tooltip (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::FieldBasedTooltipProperty, nil) (defaults to: nil) —

  The setup for the detailed tooltip.

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

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

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

  Determines whether or not the tooltip is visible.

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

def initialize(field_based_tooltip: nil, selected_tooltip_type: nil, tooltip_visibility: nil)
  @field_based_tooltip = field_based_tooltip.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FieldBasedTooltipProperty.new(**field_based_tooltip.transform_keys(&:to_sym)) : field_based_tooltip
  Jsii::Type.check_type(@field_based_tooltip, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZpZWxkQmFzZWRUb29sdGlwUHJvcGVydHkifV19fQ==")), "fieldBasedTooltip") unless @field_based_tooltip.nil?
  @selected_tooltip_type = selected_tooltip_type
  Jsii::Type.check_type(@selected_tooltip_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "selectedTooltipType") unless @selected_tooltip_type.nil?
  @tooltip_visibility = tooltip_visibility
  Jsii::Type.check_type(@tooltip_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tooltipVisibility") unless @tooltip_visibility.nil?
end

Instance Attribute Details

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

The setup for the detailed tooltip.

The tooltip setup is always saved. The display type is decided based on the tooltip type.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::FieldBasedTooltipProperty, nil)

See Also:

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

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

def field_based_tooltip
  @field_based_tooltip
end

#selected_tooltip_type ⇒ String^? (readonly)

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

• BASIC : A basic tooltip.
• DETAILED : A detailed tooltip.

Returns:

• (String, nil)

See Also:

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

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

def selected_tooltip_type
  @selected_tooltip_type
end

#tooltip_visibility ⇒ String^? (readonly)

Determines whether or not the tooltip is visible.

Returns:

• (String, nil)

See Also:

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

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

def tooltip_visibility
  @tooltip_visibility
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :field_based_tooltip => "fieldBasedTooltip",
    :selected_tooltip_type => "selectedTooltipType",
    :tooltip_visibility => "tooltipVisibility",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "fieldBasedTooltip" => @field_based_tooltip,
    "selectedTooltipType" => @selected_tooltip_type,
    "tooltipVisibility" => @tooltip_visibility,
  })
  result.compact
end