Class: AWSCDK::QuickSight::CfnDashboard::TooltipOptionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_dashboard.rb

Overview

The display options for the visual tooltip.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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::CfnDashboard::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.



30789
30790
30791
30792
30793
30794
30795
30796
 
# File 'quick_sight/cfn_dashboard.rb', line 30789

def initialize(field_based_tooltip: nil, selected_tooltip_type: nil, tooltip_visibility: nil)
  @field_based_tooltip = field_based_tooltip.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::FieldBasedTooltipProperty.new(**field_based_tooltip.transform_keys(&:to_sym)) : field_based_tooltip
  Jsii::Type.check_type(@field_based_tooltip, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5GaWVsZEJhc2VkVG9vbHRpcFByb3BlcnR5In1dfX0=")), "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:

See Also:



30804
30805
30806
 
# File 'quick_sight/cfn_dashboard.rb', line 30804

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:



30812
30813
30814
 
# File 'quick_sight/cfn_dashboard.rb', line 30812

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:



30817
30818
30819
 
# File 'quick_sight/cfn_dashboard.rb', line 30817

def tooltip_visibility
  @tooltip_visibility
end

Class Method Details

.jsii_properties ⇒ Object 



30819
30820
30821
30822
30823
30824
30825
 
# File 'quick_sight/cfn_dashboard.rb', line 30819

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

Instance Method Details

#to_jsii ⇒ Object 



30827
30828
30829
30830
30831
30832
30833
30834
30835
 
# File 'quick_sight/cfn_dashboard.rb', line 30827

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