Class: AWSCDK::QuickSight::CfnAnalysis::VisualSubtitleLabelOptionsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnAnalysis::VisualSubtitleLabelOptionsProperty

Defined in:

quick_sight/cfn_analysis.rb

Overview

The subtitle label options for a visual.

See Also:

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

Instance Attribute Summary

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

  The long text format of the subtitle label, such as plain text or rich text.

• #visibility ⇒ String^? readonly

  The visibility of the subtitle label.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(format_text: nil, visibility: nil) ⇒ VisualSubtitleLabelOptionsProperty constructor

  A new instance of VisualSubtitleLabelOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(format_text: nil, visibility: nil) ⇒ VisualSubtitleLabelOptionsProperty

Returns a new instance of VisualSubtitleLabelOptionsProperty.

Parameters:

• format_text (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnAnalysis::LongFormatTextProperty, nil) (defaults to: nil) —

  The long text format of the subtitle label, such as plain text or rich text.

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

  The visibility of the subtitle label.

# File 'quick_sight/cfn_analysis.rb', line 31516

def initialize(format_text: nil, visibility: nil)
  @format_text = format_text.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::LongFormatTextProperty.new(**format_text.transform_keys(&:to_sym)) : format_text
  Jsii::Type.check_type(@format_text, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkxvbmdGb3JtYXRUZXh0UHJvcGVydHkifV19fQ==")), "formatText") unless @format_text.nil?
  @visibility = visibility
  Jsii::Type.check_type(@visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visibility") unless @visibility.nil?
end

Instance Attribute Details

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

The long text format of the subtitle label, such as plain text or rich text.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnAnalysis::LongFormatTextProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html#cfn-quicksight-analysis-visualsubtitlelabeloptions-formattext

# File 'quick_sight/cfn_analysis.rb', line 31527

def format_text
  @format_text
end

#visibility ⇒ String^? (readonly)

The visibility of the subtitle label.

Returns:

• (String, nil)

See Also:

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

# File 'quick_sight/cfn_analysis.rb', line 31532

def visibility
  @visibility
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_analysis.rb', line 31534

def self.jsii_properties
  {
    :format_text => "formatText",
    :visibility => "visibility",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_analysis.rb', line 31541

def to_jsii
  result = {}
  result.merge!({
    "formatText" => @format_text,
    "visibility" => @visibility,
  })
  result.compact
end