Class: AWSCDK::QuickSight::CfnTemplate::SectionBasedLayoutPaperCanvasSizeOptionsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTemplate::SectionBasedLayoutPaperCanvasSizeOptionsProperty

Defined in:

quick_sight/cfn_template.rb

Overview

The options for a paper canvas of a section-based layout.

See Also:

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

Instance Attribute Summary

• #paper_margin ⇒ AWSCDK::IResolvable, ... readonly

  Defines the spacing between the canvas content and the top, bottom, left, and right edges.

• #paper_orientation ⇒ String^? readonly

  The paper orientation that is used to define canvas dimensions.

• #paper_size ⇒ String^? readonly

  The paper size that is used to define canvas dimensions.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(paper_margin: nil, paper_orientation: nil, paper_size: nil) ⇒ SectionBasedLayoutPaperCanvasSizeOptionsProperty constructor

  A new instance of SectionBasedLayoutPaperCanvasSizeOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(paper_margin: nil, paper_orientation: nil, paper_size: nil) ⇒ SectionBasedLayoutPaperCanvasSizeOptionsProperty

Returns a new instance of SectionBasedLayoutPaperCanvasSizeOptionsProperty.

Parameters:

• paper_margin (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::SpacingProperty, nil) (defaults to: nil) —

  Defines the spacing between the canvas content and the top, bottom, left, and right edges.

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

  The paper orientation that is used to define canvas dimensions. Choose one of the following options:.

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

  The paper size that is used to define canvas dimensions.

# File 'quick_sight/cfn_template.rb', line 23763

def initialize(paper_margin: nil, paper_orientation: nil, paper_size: nil)
  @paper_margin = paper_margin.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::SpacingProperty.new(**paper_margin.transform_keys(&:to_sym)) : paper_margin
  Jsii::Type.check_type(@paper_margin, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlNwYWNpbmdQcm9wZXJ0eSJ9XX19")), "paperMargin") unless @paper_margin.nil?
  @paper_orientation = paper_orientation
  Jsii::Type.check_type(@paper_orientation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "paperOrientation") unless @paper_orientation.nil?
  @paper_size = paper_size
  Jsii::Type.check_type(@paper_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "paperSize") unless @paper_size.nil?
end

Instance Attribute Details

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

Defines the spacing between the canvas content and the top, bottom, left, and right edges.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::SpacingProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-template-sectionbasedlayoutpapercanvassizeoptions-papermargin

# File 'quick_sight/cfn_template.rb', line 23776

def paper_margin
  @paper_margin
end

#paper_orientation ⇒ String^? (readonly)

The paper orientation that is used to define canvas dimensions. Choose one of the following options:.

• PORTRAIT
• LANDSCAPE

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-template-sectionbasedlayoutpapercanvassizeoptions-paperorientation

# File 'quick_sight/cfn_template.rb', line 23784

def paper_orientation
  @paper_orientation
end

#paper_size ⇒ String^? (readonly)

The paper size that is used to define canvas dimensions.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-template-sectionbasedlayoutpapercanvassizeoptions-papersize

# File 'quick_sight/cfn_template.rb', line 23789

def paper_size
  @paper_size
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_template.rb', line 23791

def self.jsii_properties
  {
    :paper_margin => "paperMargin",
    :paper_orientation => "paperOrientation",
    :paper_size => "paperSize",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_template.rb', line 23799

def to_jsii
  result = {}
  result.merge!({
    "paperMargin" => @paper_margin,
    "paperOrientation" => @paper_orientation,
    "paperSize" => @paper_size,
  })
  result.compact
end