Class: AWSCDK::QuickSight::CfnDashboard::GridLayoutScreenCanvasSizeOptionsProperty

Inherits:

Jsii::Struct

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

Defined in:

quick_sight/cfn_dashboard.rb

Overview

The options that determine the sizing of the canvas used in a grid layout.

See Also:

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

Instance Attribute Summary

• #optimized_view_port_width ⇒ String^? readonly

  The width that the view port will be optimized for when the layout renders.

• #resize_option ⇒ String readonly

  This value determines the layout behavior when the viewport is resized.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(resize_option:, optimized_view_port_width: nil) ⇒ GridLayoutScreenCanvasSizeOptionsProperty constructor

  A new instance of GridLayoutScreenCanvasSizeOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(resize_option:, optimized_view_port_width: nil) ⇒ GridLayoutScreenCanvasSizeOptionsProperty

Returns a new instance of GridLayoutScreenCanvasSizeOptionsProperty.

Parameters:

• resize_option (String) —

  This value determines the layout behavior when the viewport is resized.

• optimized_view_port_width (String, nil) (defaults to: nil) —

  The width that the view port will be optimized for when the layout renders.

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

def initialize(resize_option:, optimized_view_port_width: nil)
  @resize_option = resize_option
  Jsii::Type.check_type(@resize_option, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resizeOption")
  @optimized_view_port_width = optimized_view_port_width
  Jsii::Type.check_type(@optimized_view_port_width, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "optimizedViewPortWidth") unless @optimized_view_port_width.nil?
end

Instance Attribute Details

#optimized_view_port_width ⇒ String^? (readonly)

The width that the view port will be optimized for when the layout renders.

Returns:

• (String, nil)

See Also:

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

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

def optimized_view_port_width
  @optimized_view_port_width
end

#resize_option ⇒ String (readonly)

This value determines the layout behavior when the viewport is resized.

• FIXED : A fixed width will be used when optimizing the layout. In the Quick Sight console, this option is called Classic .
• RESPONSIVE : The width of the canvas will be responsive and optimized to the view port. In the Quick Sight console, this option is called Tiled .

Returns:

• (String)

See Also:

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

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

def resize_option
  @resize_option
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :resize_option => "resizeOption",
    :optimized_view_port_width => "optimizedViewPortWidth",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "resizeOption" => @resize_option,
    "optimizedViewPortWidth" => @optimized_view_port_width,
  })
  result.compact
end