Class: AWSCDK::QuickSight::CfnDashboard::GridLayoutConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnDashboard::GridLayoutConfigurationProperty

Defined in:

quick_sight/cfn_dashboard.rb

Overview

The configuration for a grid layout. Also called a tiled 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.

See Also:

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

Instance Attribute Summary

• #canvas_size_options ⇒ AWSCDK::IResolvable, ... readonly
• #elements ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::GridLayoutElementProperty> readonly

  The elements that are included in a grid layout.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(elements:, canvas_size_options: nil) ⇒ GridLayoutConfigurationProperty constructor

  A new instance of GridLayoutConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(elements:, canvas_size_options: nil) ⇒ GridLayoutConfigurationProperty

Returns a new instance of GridLayoutConfigurationProperty.

Parameters:

• elements (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::GridLayoutElementProperty>) —

  The elements that are included in a grid layout.

• canvas_size_options (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::GridLayoutCanvasSizeOptionsProperty, nil) (defaults to: nil)

# File 'quick_sight/cfn_dashboard.rb', line 15491

def initialize(elements:, canvas_size_options: nil)
  @elements = elements
  Jsii::Type.check_type(@elements, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuR3JpZExheW91dEVsZW1lbnRQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "elements")
  @canvas_size_options = canvas_size_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::GridLayoutCanvasSizeOptionsProperty.new(**canvas_size_options.transform_keys(&:to_sym)) : canvas_size_options
  Jsii::Type.check_type(@canvas_size_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5HcmlkTGF5b3V0Q2FudmFzU2l6ZU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "canvasSizeOptions") unless @canvas_size_options.nil?
end

Instance Attribute Details

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

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::GridLayoutCanvasSizeOptionsProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutconfiguration.html#cfn-quicksight-dashboard-gridlayoutconfiguration-canvassizeoptions

# File 'quick_sight/cfn_dashboard.rb', line 15505

def canvas_size_options
  @canvas_size_options
end

#elements ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::GridLayoutElementProperty> (readonly)

The elements that are included in a grid layout.

Returns:

• (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::GridLayoutElementProperty>)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutconfiguration.html#cfn-quicksight-dashboard-gridlayoutconfiguration-elements

# File 'quick_sight/cfn_dashboard.rb', line 15502

def elements
  @elements
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_dashboard.rb', line 15507

def self.jsii_properties
  {
    :elements => "elements",
    :canvas_size_options => "canvasSizeOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_dashboard.rb', line 15514

def to_jsii
  result = {}
  result.merge!({
    "elements" => @elements,
    "canvasSizeOptions" => @canvas_size_options,
  })
  result.compact
end