Class: AWSCDK::QuickSight::CfnAnalysis::LegendOptionsProperty

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

Overview

The options for the legend setup of a visual.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(height: nil, position: nil, title: nil, value_font_configuration: nil, visibility: nil, width: nil) ⇒ LegendOptionsProperty

Returns a new instance of LegendOptionsProperty.

Parameters:



17502
17503
17504
17505
17506
17507
17508
17509
17510
17511
17512
17513
17514
17515
 
# File 'quick_sight/cfn_analysis.rb', line 17502

def initialize(height: nil, position: nil, title: nil, value_font_configuration: nil, visibility: nil, width: nil)
  @height = height
  Jsii::Type.check_type(@height, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "height") unless @height.nil?
  @position = position
  Jsii::Type.check_type(@position, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "position") unless @position.nil?
  @title = title.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::LabelOptionsProperty.new(**title.transform_keys(&:to_sym)) : title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkxhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "title") unless @title.nil?
  @value_font_configuration = value_font_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::FontConfigurationProperty.new(**value_font_configuration.transform_keys(&:to_sym)) : value_font_configuration
  Jsii::Type.check_type(@value_font_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkZvbnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "valueFontConfiguration") unless @value_font_configuration.nil?
  @visibility = visibility
  Jsii::Type.check_type(@visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visibility") unless @visibility.nil?
  @width = width
  Jsii::Type.check_type(@width, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "width") unless @width.nil?
end

Instance Attribute Details

#height ⇒ String? (readonly)

The height of the legend.

If this value is omitted, a default height is used when rendering.

Returns:

  • (String, nil)

See Also:



17523
17524
17525
 
# File 'quick_sight/cfn_analysis.rb', line 17523

def height
  @height
end

#position ⇒ String? (readonly)

The positions for the legend. Choose one of the following options:.

  • AUTO
  • RIGHT
  • BOTTOM
  • LEFT

Returns:

  • (String, nil)

See Also:



17533
17534
17535
 
# File 'quick_sight/cfn_analysis.rb', line 17533

def position
  @position
end

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

The custom title for the legend.

Returns:

See Also:



17538
17539
17540
 
# File 'quick_sight/cfn_analysis.rb', line 17538

def title
  @title
end

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

Returns:

See Also:



17541
17542
17543
 
# File 'quick_sight/cfn_analysis.rb', line 17541

def value_font_configuration
  @value_font_configuration
end

#visibility ⇒ String? (readonly)

Determines whether or not the legend is visible.

Returns:

  • (String, nil)

See Also:



17546
17547
17548
 
# File 'quick_sight/cfn_analysis.rb', line 17546

def visibility
  @visibility
end

#width ⇒ String? (readonly)

The width of the legend.

If this value is omitted, a default width is used when rendering.

Returns:

  • (String, nil)

See Also:



17553
17554
17555
 
# File 'quick_sight/cfn_analysis.rb', line 17553

def width
  @width
end

Class Method Details

.jsii_properties ⇒ Object 



17555
17556
17557
17558
17559
17560
17561
17562
17563
17564
 
# File 'quick_sight/cfn_analysis.rb', line 17555

def self.jsii_properties
  {
    :height => "height",
    :position => "position",
    :title => "title",
    :value_font_configuration => "valueFontConfiguration",
    :visibility => "visibility",
    :width => "width",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



17566
17567
17568
17569
17570
17571
17572
17573
17574
17575
17576
17577
 
# File 'quick_sight/cfn_analysis.rb', line 17566

def to_jsii
  result = {}
  result.merge!({
    "height" => @height,
    "position" => @position,
    "title" => @title,
    "valueFontConfiguration" => @value_font_configuration,
    "visibility" => @visibility,
    "width" => @width,
  })
  result.compact
end