Class: AWSCDK::QuickSight::CfnTemplate::FreeFormLayoutElementProperty

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

Overview

An element within a free-form layout.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(element_id:, element_type:, height:, width:, x_axis_location:, y_axis_location:, background_style: nil, border_style: nil, loading_animation: nil, rendering_rules: nil, selected_border_style: nil, visibility: nil) ⇒ FreeFormLayoutElementProperty

Returns a new instance of FreeFormLayoutElementProperty.

Parameters:



11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
 
# File 'quick_sight/cfn_template.rb', line 11343

def initialize(element_id:, element_type:, height:, width:, x_axis_location:, y_axis_location:, background_style: nil, border_style: nil, loading_animation: nil, rendering_rules: nil, selected_border_style: nil, visibility: nil)
  @element_id = element_id
  Jsii::Type.check_type(@element_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "elementId")
  @element_type = element_type
  Jsii::Type.check_type(@element_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "elementType")
  @height = height
  Jsii::Type.check_type(@height, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "height")
  @width = width
  Jsii::Type.check_type(@width, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "width")
  @x_axis_location = x_axis_location
  Jsii::Type.check_type(@x_axis_location, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "xAxisLocation")
  @y_axis_location = y_axis_location
  Jsii::Type.check_type(@y_axis_location, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "yAxisLocation")
  @background_style = background_style.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FreeFormLayoutElementBackgroundStyleProperty.new(**background_style.transform_keys(&:to_sym)) : background_style
  Jsii::Type.check_type(@background_style, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZyZWVGb3JtTGF5b3V0RWxlbWVudEJhY2tncm91bmRTdHlsZVByb3BlcnR5In1dfX0=")), "backgroundStyle") unless @background_style.nil?
  @border_style = border_style.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FreeFormLayoutElementBorderStyleProperty.new(**border_style.transform_keys(&:to_sym)) : border_style
  Jsii::Type.check_type(@border_style, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZyZWVGb3JtTGF5b3V0RWxlbWVudEJvcmRlclN0eWxlUHJvcGVydHkifV19fQ==")), "borderStyle") unless @border_style.nil?
  @loading_animation = loading_animation.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::LoadingAnimationProperty.new(**loading_animation.transform_keys(&:to_sym)) : loading_animation
  Jsii::Type.check_type(@loading_animation, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkxvYWRpbmdBbmltYXRpb25Qcm9wZXJ0eSJ9XX19")), "loadingAnimation") unless @loading_animation.nil?
  @rendering_rules = rendering_rules
  Jsii::Type.check_type(@rendering_rules, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5TaGVldEVsZW1lbnRSZW5kZXJpbmdSdWxlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "renderingRules") unless @rendering_rules.nil?
  @selected_border_style = selected_border_style.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FreeFormLayoutElementBorderStyleProperty.new(**selected_border_style.transform_keys(&:to_sym)) : selected_border_style
  Jsii::Type.check_type(@selected_border_style, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZyZWVGb3JtTGF5b3V0RWxlbWVudEJvcmRlclN0eWxlUHJvcGVydHkifV19fQ==")), "selectedBorderStyle") unless @selected_border_style.nil?
  @visibility = visibility
  Jsii::Type.check_type(@visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visibility") unless @visibility.nil?
end

Instance Attribute Details

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

The background style configuration of a free-form layout element.

Returns:

See Also:



11404
11405
11406
 
# File 'quick_sight/cfn_template.rb', line 11404

def background_style
  @background_style
end

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

The border style configuration of a free-form layout element.

Returns:

See Also:



11409
11410
11411
 
# File 'quick_sight/cfn_template.rb', line 11409

def border_style
  @border_style
end

#element_id ⇒ String (readonly)

A unique identifier for an element within a free-form layout.

Returns:

  • (String)

See Also:



11374
11375
11376
 
# File 'quick_sight/cfn_template.rb', line 11374

def element_id
  @element_id
end

#element_type ⇒ String (readonly)

The type of element.

Returns:

  • (String)

See Also:



11379
11380
11381
 
# File 'quick_sight/cfn_template.rb', line 11379

def element_type
  @element_type
end

#height ⇒ String (readonly)

The height of an element within a free-form layout.

Returns:

  • (String)

See Also:



11384
11385
11386
 
# File 'quick_sight/cfn_template.rb', line 11384

def height
  @height
end

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

The loading animation configuration of a free-form layout element.

Returns:

See Also:



11414
11415
11416
 
# File 'quick_sight/cfn_template.rb', line 11414

def loading_animation
  @loading_animation
end

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

The rendering rules that determine when an element should be displayed within a free-form layout.

Returns:

See Also:



11419
11420
11421
 
# File 'quick_sight/cfn_template.rb', line 11419

def rendering_rules
  @rendering_rules
end

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

The border style configuration of a free-form layout element.

This border style is used when the element is selected.

Returns:

See Also:



11426
11427
11428
 
# File 'quick_sight/cfn_template.rb', line 11426

def selected_border_style
  @selected_border_style
end

#visibility ⇒ String? (readonly)

The visibility of an element within a free-form layout.

Returns:

  • (String, nil)

See Also:



11431
11432
11433
 
# File 'quick_sight/cfn_template.rb', line 11431

def visibility
  @visibility
end

#width ⇒ String (readonly)

The width of an element within a free-form layout.

Returns:

  • (String)

See Also:



11389
11390
11391
 
# File 'quick_sight/cfn_template.rb', line 11389

def width
  @width
end

#x_axis_location ⇒ String (readonly)

The x-axis coordinate of the element.

Returns:

  • (String)

See Also:



11394
11395
11396
 
# File 'quick_sight/cfn_template.rb', line 11394

def x_axis_location
  @x_axis_location
end

#y_axis_location ⇒ String (readonly)

The y-axis coordinate of the element.

Returns:

  • (String)

See Also:



11399
11400
11401
 
# File 'quick_sight/cfn_template.rb', line 11399

def y_axis_location
  @y_axis_location
end

Class Method Details

.jsii_properties ⇒ Object 



11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
 
# File 'quick_sight/cfn_template.rb', line 11433

def self.jsii_properties
  {
    :element_id => "elementId",
    :element_type => "elementType",
    :height => "height",
    :width => "width",
    :x_axis_location => "xAxisLocation",
    :y_axis_location => "yAxisLocation",
    :background_style => "backgroundStyle",
    :border_style => "borderStyle",
    :loading_animation => "loadingAnimation",
    :rendering_rules => "renderingRules",
    :selected_border_style => "selectedBorderStyle",
    :visibility => "visibility",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
 
# File 'quick_sight/cfn_template.rb', line 11450

def to_jsii
  result = {}
  result.merge!({
    "elementId" => @element_id,
    "elementType" => @element_type,
    "height" => @height,
    "width" => @width,
    "xAxisLocation" => @x_axis_location,
    "yAxisLocation" => @y_axis_location,
    "backgroundStyle" => @background_style,
    "borderStyle" => @border_style,
    "loadingAnimation" => @loading_animation,
    "renderingRules" => @rendering_rules,
    "selectedBorderStyle" => @selected_border_style,
    "visibility" => @visibility,
  })
  result.compact
end