Class: AWSCDK::QuickSight::CfnDashboard::PivotTotalOptionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_dashboard.rb

Overview

The optional configuration of totals cells in a PivotTableVisual .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(custom_label: nil, metric_header_cell_style: nil, placement: nil, scroll_status: nil, total_aggregation_options: nil, total_cell_style: nil, totals_visibility: nil, value_cell_style: nil) ⇒ PivotTotalOptionsProperty

Returns a new instance of PivotTotalOptionsProperty.

Parameters:



23688
23689
23690
23691
23692
23693
23694
23695
23696
23697
23698
23699
23700
23701
23702
23703
23704
23705
 
# File 'quick_sight/cfn_dashboard.rb', line 23688

def initialize(custom_label: nil, metric_header_cell_style: nil, placement: nil, scroll_status: nil, total_aggregation_options: nil, total_cell_style: nil, totals_visibility: nil, value_cell_style: nil)
  @custom_label = custom_label
  Jsii::Type.check_type(@custom_label, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customLabel") unless @custom_label.nil?
  @metric_header_cell_style = metric_header_cell_style.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::TableCellStyleProperty.new(**metric_header_cell_style.transform_keys(&:to_sym)) : metric_header_cell_style
  Jsii::Type.check_type(@metric_header_cell_style, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5UYWJsZUNlbGxTdHlsZVByb3BlcnR5In1dfX0=")), "metricHeaderCellStyle") unless @metric_header_cell_style.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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuVG90YWxBZ2dyZWdhdGlvbk9wdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "totalAggregationOptions") unless @total_aggregation_options.nil?
  @total_cell_style = total_cell_style.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::TableCellStyleProperty.new(**total_cell_style.transform_keys(&:to_sym)) : total_cell_style
  Jsii::Type.check_type(@total_cell_style, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5UYWJsZUNlbGxTdHlsZVByb3BlcnR5In1dfX0=")), "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?
  @value_cell_style = value_cell_style.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::TableCellStyleProperty.new(**value_cell_style.transform_keys(&:to_sym)) : value_cell_style
  Jsii::Type.check_type(@value_cell_style, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5UYWJsZUNlbGxTdHlsZVByb3BlcnR5In1dfX0=")), "valueCellStyle") unless @value_cell_style.nil?
end

Instance Attribute Details

#custom_label ⇒ String? (readonly)

The custom label string for the total cells.

Returns:

  • (String, nil)

See Also:



23711
23712
23713
 
# File 'quick_sight/cfn_dashboard.rb', line 23711

def custom_label
  @custom_label
end

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

The cell styling options for the total of header cells.

Returns:

See Also:



23716
23717
23718
 
# File 'quick_sight/cfn_dashboard.rb', line 23716

def metric_header_cell_style
  @metric_header_cell_style
end

#placement ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



23721
23722
23723
 
# File 'quick_sight/cfn_dashboard.rb', line 23721

def placement
  @placement
end

#scroll_status ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



23726
23727
23728
 
# File 'quick_sight/cfn_dashboard.rb', line 23726

def scroll_status
  @scroll_status
end

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

The total aggregation options for each value field.

Returns:

See Also:



23731
23732
23733
 
# File 'quick_sight/cfn_dashboard.rb', line 23731

def total_aggregation_options
  @total_aggregation_options
end

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

The cell styling options for the total cells.

Returns:

See Also:



23736
23737
23738
 
# File 'quick_sight/cfn_dashboard.rb', line 23736

def total_cell_style
  @total_cell_style
end

#totals_visibility ⇒ String? (readonly)

The visibility configuration for the total cells.

Returns:

  • (String, nil)

See Also:



23741
23742
23743
 
# File 'quick_sight/cfn_dashboard.rb', line 23741

def totals_visibility
  @totals_visibility
end

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

The cell styling options for the totals of value cells.

Returns:

See Also:



23746
23747
23748
 
# File 'quick_sight/cfn_dashboard.rb', line 23746

def value_cell_style
  @value_cell_style
end

Class Method Details

.jsii_properties ⇒ Object 



23748
23749
23750
23751
23752
23753
23754
23755
23756
23757
23758
23759
 
# File 'quick_sight/cfn_dashboard.rb', line 23748

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

Instance Method Details

#to_jsii ⇒ Object 



23761
23762
23763
23764
23765
23766
23767
23768
23769
23770
23771
23772
23773
23774
 
# File 'quick_sight/cfn_dashboard.rb', line 23761

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