Class: AWSCDK::QuickSight::CfnTemplate::LayoutConfigurationProperty

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

Overview

The configuration that determines what the type of layout will be used on a sheet.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(free_form_layout: nil, grid_layout: nil, section_based_layout: nil) ⇒ LayoutConfigurationProperty

Returns a new instance of LayoutConfigurationProperty.

Parameters:



15596
15597
15598
15599
15600
15601
15602
15603
 
# File 'quick_sight/cfn_template.rb', line 15596

def initialize(free_form_layout: nil, grid_layout: nil, section_based_layout: nil)
  @free_form_layout = free_form_layout.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FreeFormLayoutConfigurationProperty.new(**free_form_layout.transform_keys(&:to_sym)) : free_form_layout
  Jsii::Type.check_type(@free_form_layout, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZyZWVGb3JtTGF5b3V0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "freeFormLayout") unless @free_form_layout.nil?
  @grid_layout = grid_layout.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::GridLayoutConfigurationProperty.new(**grid_layout.transform_keys(&:to_sym)) : grid_layout
  Jsii::Type.check_type(@grid_layout, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkdyaWRMYXlvdXRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "gridLayout") unless @grid_layout.nil?
  @section_based_layout = section_based_layout.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::SectionBasedLayoutConfigurationProperty.new(**section_based_layout.transform_keys(&:to_sym)) : section_based_layout
  Jsii::Type.check_type(@section_based_layout, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlNlY3Rpb25CYXNlZExheW91dENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "sectionBasedLayout") unless @section_based_layout.nil?
end

Instance Attribute Details

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

A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

Returns:

See Also:



15609
15610
15611
 
# File 'quick_sight/cfn_template.rb', line 15609

def free_form_layout
  @free_form_layout
end

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

A type of layout that can be used on a sheet.

In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE .

Returns:

See Also:



15616
15617
15618
 
# File 'quick_sight/cfn_template.rb', line 15616

def grid_layout
  @grid_layout
end

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

A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

Returns:

See Also:



15621
15622
15623
 
# File 'quick_sight/cfn_template.rb', line 15621

def section_based_layout
  @section_based_layout
end

Class Method Details

.jsii_properties ⇒ Object 



15623
15624
15625
15626
15627
15628
15629
 
# File 'quick_sight/cfn_template.rb', line 15623

def self.jsii_properties
  {
    :free_form_layout => "freeFormLayout",
    :grid_layout => "gridLayout",
    :section_based_layout => "sectionBasedLayout",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



15631
15632
15633
15634
15635
15636
15637
15638
15639
 
# File 'quick_sight/cfn_template.rb', line 15631

def to_jsii
  result = {}
  result.merge!({
    "freeFormLayout" => @free_form_layout,
    "gridLayout" => @grid_layout,
    "sectionBasedLayout" => @section_based_layout,
  })
  result.compact
end