Class: AWSCDK::QuickSight::CfnTemplate::TotalOptionsProperty

Inherits:

Jsii::Struct

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

Defined in:

quick_sight/cfn_template.rb

Overview

The total options for a table visual.

See Also:

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

Instance Attribute Summary

• #custom_label ⇒ String^? readonly

  The custom label string for the total cells.

• #placement ⇒ String^? readonly

  The placement (start, end) for the total cells.

• #scroll_status ⇒ String^? readonly

  The scroll status (pinned, scrolled) for the total cells.

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

  The total aggregation settings for each value field.

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

  Cell styling options for the total cells.

• #totals_visibility ⇒ String^? readonly

  The visibility configuration for the total cells.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(custom_label: nil, placement: nil, scroll_status: nil, total_aggregation_options: nil, total_cell_style: nil, totals_visibility: nil) ⇒ TotalOptionsProperty constructor

  A new instance of TotalOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(custom_label: nil, placement: nil, scroll_status: nil, total_aggregation_options: nil, total_cell_style: nil, totals_visibility: nil) ⇒ TotalOptionsProperty

Returns a new instance of TotalOptionsProperty.

Parameters:

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

  The custom label string for the total cells.

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

  The placement (start, end) for the total cells.

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

  The scroll status (pinned, scrolled) for the total cells.

• total_aggregation_options (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::TotalAggregationOptionProperty>, nil) (defaults to: nil) —

  The total aggregation settings for each value field.

• total_cell_style (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::TableCellStyleProperty, nil) (defaults to: nil) —

  Cell styling options for the total cells.

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

  The visibility configuration for the total cells.

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

def initialize(custom_label: nil, placement: nil, scroll_status: nil, total_aggregation_options: nil, total_cell_style: nil, totals_visibility: nil)
  @custom_label = custom_label
  Jsii::Type.check_type(@custom_label, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customLabel") unless @custom_label.nil?
  @placement = placement
  Jsii::Type.check_type(@placement, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "placement") unless @placement.nil?
  @scroll_status = scroll_status
  Jsii::Type.check_type(@scroll_status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scrollStatus") unless @scroll_status.nil?
  @total_aggregation_options = total_aggregation_options
  Jsii::Type.check_type(@total_aggregation_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5Ub3RhbEFnZ3JlZ2F0aW9uT3B0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "totalAggregationOptions") unless @total_aggregation_options.nil?
  @total_cell_style = total_cell_style.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::TableCellStyleProperty.new(**total_cell_style.transform_keys(&:to_sym)) : total_cell_style
  Jsii::Type.check_type(@total_cell_style, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRhYmxlQ2VsbFN0eWxlUHJvcGVydHkifV19fQ==")), "totalCellStyle") unless @total_cell_style.nil?
  @totals_visibility = totals_visibility
  Jsii::Type.check_type(@totals_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "totalsVisibility") unless @totals_visibility.nil?
end

Instance Attribute Details

#custom_label ⇒ String^? (readonly)

The custom label string for the total cells.

Returns:

• (String, nil)

See Also:

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

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

def custom_label
  @custom_label
end

#placement ⇒ String^? (readonly)

The placement (start, end) for the total cells.

Returns:

• (String, nil)

See Also:

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

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

def placement
  @placement
end

#scroll_status ⇒ String^? (readonly)

The scroll status (pinned, scrolled) for the total cells.

Returns:

• (String, nil)

See Also:

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

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

def scroll_status
  @scroll_status
end

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

The total aggregation settings for each value field.

Returns:

• (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::TotalAggregationOptionProperty>, nil)

See Also:

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

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

def total_aggregation_options
  @total_aggregation_options
end

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

Cell styling options for the total cells.

Returns:

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

See Also:

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

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

def total_cell_style
  @total_cell_style
end

#totals_visibility ⇒ String^? (readonly)

The visibility configuration for the total cells.

Returns:

• (String, nil)

See Also:

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

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

def totals_visibility
  @totals_visibility
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :custom_label => "customLabel",
    :placement => "placement",
    :scroll_status => "scrollStatus",
    :total_aggregation_options => "totalAggregationOptions",
    :total_cell_style => "totalCellStyle",
    :totals_visibility => "totalsVisibility",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "customLabel" => @custom_label,
    "placement" => @placement,
    "scrollStatus" => @scroll_status,
    "totalAggregationOptions" => @total_aggregation_options,
    "totalCellStyle" => @total_cell_style,
    "totalsVisibility" => @totals_visibility,
  })
  result.compact
end