Class: AWSCDK::QuickSight::CfnDashboard::LegendOptionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_dashboard.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:



18441
18442
18443
18444
18445
18446
18447
18448
18449
18450
18451
18452
18453
18454
 
# File 'quick_sight/cfn_dashboard.rb', line 18441

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::CfnDashboard::LabelOptionsProperty.new(**title.transform_keys(&:to_sym)) : title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5MYWJlbE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "title") unless @title.nil?
  @value_font_configuration = value_font_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::FontConfigurationProperty.new(**value_font_configuration.transform_keys(&:to_sym)) : value_font_configuration
  Jsii::Type.check_type(@value_font_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Gb250Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "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:



18462
18463
18464
 
# File 'quick_sight/cfn_dashboard.rb', line 18462

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:



18472
18473
18474
 
# File 'quick_sight/cfn_dashboard.rb', line 18472

def position
  @position
end

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

The custom title for the legend.

Returns:

See Also:



18477
18478
18479
 
# File 'quick_sight/cfn_dashboard.rb', line 18477

def title
  @title
end

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

Returns:

See Also:



18480
18481
18482
 
# File 'quick_sight/cfn_dashboard.rb', line 18480

def value_font_configuration
  @value_font_configuration
end

#visibility ⇒ String? (readonly)

Determines whether or not the legend is visible.

Returns:

  • (String, nil)

See Also:



18485
18486
18487
 
# File 'quick_sight/cfn_dashboard.rb', line 18485

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:



18492
18493
18494
 
# File 'quick_sight/cfn_dashboard.rb', line 18492

def width
  @width
end

Class Method Details

.jsii_properties ⇒ Object 



18494
18495
18496
18497
18498
18499
18500
18501
18502
18503
 
# File 'quick_sight/cfn_dashboard.rb', line 18494

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 



18505
18506
18507
18508
18509
18510
18511
18512
18513
18514
18515
18516
 
# File 'quick_sight/cfn_dashboard.rb', line 18505

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