Class: AWSCDK::QuickSight::CfnTemplate::GridLayoutElementProperty

Inherits:

Jsii::Struct

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

Defined in:

quick_sight/cfn_template.rb

Overview

An element within a grid layout.

See Also:

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

Instance Attribute Summary

• #column_index ⇒ Numeric^? readonly

  The column index for the upper left corner of an element.

• #column_span ⇒ Numeric readonly

  The width of a grid element expressed as a number of grid columns.

• #element_id ⇒ String readonly

  A unique identifier for an element within a grid layout.

• #element_type ⇒ String readonly

  The type of element.

• #row_index ⇒ Numeric^? readonly

  The row index for the upper left corner of an element.

• #row_span ⇒ Numeric readonly

  The height of a grid element expressed as a number of grid rows.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(column_span:, element_id:, element_type:, row_span:, column_index: nil, row_index: nil) ⇒ GridLayoutElementProperty constructor

  A new instance of GridLayoutElementProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(column_span:, element_id:, element_type:, row_span:, column_index: nil, row_index: nil) ⇒ GridLayoutElementProperty

Returns a new instance of GridLayoutElementProperty.

Parameters:

• column_span (Numeric) —

  The width of a grid element expressed as a number of grid columns.

• element_id (String) —

  A unique identifier for an element within a grid layout.

• element_type (String) —

  The type of element.

• row_span (Numeric) —

  The height of a grid element expressed as a number of grid rows.

• column_index (Numeric, nil) (defaults to: nil) —

  The column index for the upper left corner of an element.

• row_index (Numeric, nil) (defaults to: nil) —

  The row index for the upper left corner of an element.

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

def initialize(column_span:, element_id:, element_type:, row_span:, column_index: nil, row_index: nil)
  @column_span = column_span
  Jsii::Type.check_type(@column_span, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "columnSpan")
  @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")
  @row_span = row_span
  Jsii::Type.check_type(@row_span, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "rowSpan")
  @column_index = column_index
  Jsii::Type.check_type(@column_index, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "columnIndex") unless @column_index.nil?
  @row_index = row_index
  Jsii::Type.check_type(@row_index, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "rowIndex") unless @row_index.nil?
end

Instance Attribute Details

#column_index ⇒ Numeric^? (readonly)

The column index for the upper left corner of an element.

Returns:

• (Numeric, nil)

See Also:

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

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

def column_index
  @column_index
end

#column_span ⇒ Numeric (readonly)

The width of a grid element expressed as a number of grid columns.

Returns:

• (Numeric)

See Also:

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

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

def column_span
  @column_span
end

#element_id ⇒ String (readonly)

A unique identifier for an element within a grid layout.

Returns:

• (String)

See Also:

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

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

def element_id
  @element_id
end

#element_type ⇒ String (readonly)

The type of element.

Returns:

• (String)

See Also:

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

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

def element_type
  @element_type
end

#row_index ⇒ Numeric^? (readonly)

The row index for the upper left corner of an element.

Returns:

• (Numeric, nil)

See Also:

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

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

def row_index
  @row_index
end

#row_span ⇒ Numeric (readonly)

The height of a grid element expressed as a number of grid rows.

Returns:

• (Numeric)

See Also:

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

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

def row_span
  @row_span
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :column_span => "columnSpan",
    :element_id => "elementId",
    :element_type => "elementType",
    :row_span => "rowSpan",
    :column_index => "columnIndex",
    :row_index => "rowIndex",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "columnSpan" => @column_span,
    "elementId" => @element_id,
    "elementType" => @element_type,
    "rowSpan" => @row_span,
    "columnIndex" => @column_index,
    "rowIndex" => @row_index,
  })
  result.compact
end