Class: AWSCDK::QuickSight::CfnDashboard::FieldTooltipItemProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnDashboard::FieldTooltipItemProperty

Defined in:

quick_sight/cfn_dashboard.rb

Overview

The tooltip item for the fields.

See Also:

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

Instance Attribute Summary

• #field_id ⇒ String readonly

  The unique ID of the field that is targeted by the tooltip.

• #label ⇒ String^? readonly

  The label of the tooltip item.

• #tooltip_target ⇒ String^? readonly

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

• #visibility ⇒ String^? readonly

  The visibility of the tooltip item.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(field_id:, label: nil, tooltip_target: nil, visibility: nil) ⇒ FieldTooltipItemProperty constructor

  A new instance of FieldTooltipItemProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(field_id:, label: nil, tooltip_target: nil, visibility: nil) ⇒ FieldTooltipItemProperty

Returns a new instance of FieldTooltipItemProperty.

Parameters:

• field_id (String) —

  The unique ID of the field that is targeted by the tooltip.

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

  The label of the tooltip item.

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

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

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

  The visibility of the tooltip item.

# File 'quick_sight/cfn_dashboard.rb', line 9993

def initialize(field_id:, label: nil, tooltip_target: nil, visibility: nil)
  @field_id = field_id
  Jsii::Type.check_type(@field_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fieldId")
  @label = label
  Jsii::Type.check_type(@label, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "label") unless @label.nil?
  @tooltip_target = tooltip_target
  Jsii::Type.check_type(@tooltip_target, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tooltipTarget") unless @tooltip_target.nil?
  @visibility = visibility
  Jsii::Type.check_type(@visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visibility") unless @visibility.nil?
end

Instance Attribute Details

#field_id ⇒ String (readonly)

The unique ID of the field that is targeted by the tooltip.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldtooltipitem.html#cfn-quicksight-dashboard-fieldtooltipitem-fieldid

# File 'quick_sight/cfn_dashboard.rb', line 10008

def field_id
  @field_id
end

#label ⇒ String^? (readonly)

The label of the tooltip item.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldtooltipitem.html#cfn-quicksight-dashboard-fieldtooltipitem-label

# File 'quick_sight/cfn_dashboard.rb', line 10013

def label
  @label
end

#tooltip_target ⇒ String^? (readonly)

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

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldtooltipitem.html#cfn-quicksight-dashboard-fieldtooltipitem-tooltiptarget

# File 'quick_sight/cfn_dashboard.rb', line 10018

def tooltip_target
  @tooltip_target
end

#visibility ⇒ String^? (readonly)

The visibility of the tooltip item.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldtooltipitem.html#cfn-quicksight-dashboard-fieldtooltipitem-visibility

# File 'quick_sight/cfn_dashboard.rb', line 10023

def visibility
  @visibility
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_dashboard.rb', line 10025

def self.jsii_properties
  {
    :field_id => "fieldId",
    :label => "label",
    :tooltip_target => "tooltipTarget",
    :visibility => "visibility",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_dashboard.rb', line 10034

def to_jsii
  result = {}
  result.merge!({
    "fieldId" => @field_id,
    "label" => @label,
    "tooltipTarget" => @tooltip_target,
    "visibility" => @visibility,
  })
  result.compact
end