Class: AWSCDK::QuickSight::CfnDashboard::TotalOptionsProperty

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

Overview

The total options for a table visual.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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:



31268
31269
31270
31271
31272
31273
31274
31275
31276
31277
31278
31279
31280
31281
 
# File 'quick_sight/cfn_dashboard.rb', line 31268

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("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?
end

Instance Attribute Details

#custom_label ⇒ String? (readonly)

The custom label string for the total cells.

Returns:

  • (String, nil)

See Also:



31287
31288
31289
 
# File 'quick_sight/cfn_dashboard.rb', line 31287

def custom_label
  @custom_label
end

#placement ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



31292
31293
31294
 
# File 'quick_sight/cfn_dashboard.rb', line 31292

def placement
  @placement
end

#scroll_status ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



31297
31298
31299
 
# File 'quick_sight/cfn_dashboard.rb', line 31297

def scroll_status
  @scroll_status
end

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

The total aggregation settings for each value field.

Returns:

See Also:



31302
31303
31304
 
# File 'quick_sight/cfn_dashboard.rb', line 31302

def total_aggregation_options
  @total_aggregation_options
end

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

Cell styling options for the total cells.

Returns:

See Also:



31307
31308
31309
 
# File 'quick_sight/cfn_dashboard.rb', line 31307

def total_cell_style
  @total_cell_style
end

#totals_visibility ⇒ String? (readonly)

The visibility configuration for the total cells.

Returns:

  • (String, nil)

See Also:



31312
31313
31314
 
# File 'quick_sight/cfn_dashboard.rb', line 31312

def totals_visibility
  @totals_visibility
end

Class Method Details

.jsii_properties ⇒ Object 



31314
31315
31316
31317
31318
31319
31320
31321
31322
31323
 
# File 'quick_sight/cfn_dashboard.rb', line 31314

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 



31325
31326
31327
31328
31329
31330
31331
31332
31333
31334
31335
31336
 
# File 'quick_sight/cfn_dashboard.rb', line 31325

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