Class: AWSCDK::QuickSight::CfnAnalysis::PivotTableOptionsProperty

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

Overview

The table options for a pivot table visual.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cell_style: nil, collapsed_row_dimensions_visibility: nil, column_header_style: nil, column_names_visibility: nil, default_cell_width: nil, metric_placement: nil, row_alternate_color_options: nil, row_field_names_style: nil, row_header_style: nil, rows_label_options: nil, rows_layout: nil, single_metric_visibility: nil, toggle_buttons_visibility: nil) ⇒ PivotTableOptionsProperty

Returns a new instance of PivotTableOptionsProperty.

Parameters:



22227
22228
22229
22230
22231
22232
22233
22234
22235
22236
22237
22238
22239
22240
22241
22242
22243
22244
22245
22246
22247
22248
22249
22250
22251
22252
22253
22254
 
# File 'quick_sight/cfn_analysis.rb', line 22227

def initialize(cell_style: nil, collapsed_row_dimensions_visibility: nil, column_header_style: nil, column_names_visibility: nil, default_cell_width: nil, metric_placement: nil, row_alternate_color_options: nil, row_field_names_style: nil, row_header_style: nil, rows_label_options: nil, rows_layout: nil, single_metric_visibility: nil, toggle_buttons_visibility: nil)
  @cell_style = cell_style.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::TableCellStyleProperty.new(**cell_style.transform_keys(&:to_sym)) : cell_style
  Jsii::Type.check_type(@cell_style, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlRhYmxlQ2VsbFN0eWxlUHJvcGVydHkifV19fQ==")), "cellStyle") unless @cell_style.nil?
  @collapsed_row_dimensions_visibility = collapsed_row_dimensions_visibility
  Jsii::Type.check_type(@collapsed_row_dimensions_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "collapsedRowDimensionsVisibility") unless @collapsed_row_dimensions_visibility.nil?
  @column_header_style = column_header_style.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::TableCellStyleProperty.new(**column_header_style.transform_keys(&:to_sym)) : column_header_style
  Jsii::Type.check_type(@column_header_style, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlRhYmxlQ2VsbFN0eWxlUHJvcGVydHkifV19fQ==")), "columnHeaderStyle") unless @column_header_style.nil?
  @column_names_visibility = column_names_visibility
  Jsii::Type.check_type(@column_names_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "columnNamesVisibility") unless @column_names_visibility.nil?
  @default_cell_width = default_cell_width
  Jsii::Type.check_type(@default_cell_width, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultCellWidth") unless @default_cell_width.nil?
  @metric_placement = metric_placement
  Jsii::Type.check_type(@metric_placement, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricPlacement") unless @metric_placement.nil?
  @row_alternate_color_options = row_alternate_color_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::RowAlternateColorOptionsProperty.new(**row_alternate_color_options.transform_keys(&:to_sym)) : row_alternate_color_options
  Jsii::Type.check_type(@row_alternate_color_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlJvd0FsdGVybmF0ZUNvbG9yT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "rowAlternateColorOptions") unless @row_alternate_color_options.nil?
  @row_field_names_style = row_field_names_style.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::TableCellStyleProperty.new(**row_field_names_style.transform_keys(&:to_sym)) : row_field_names_style
  Jsii::Type.check_type(@row_field_names_style, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlRhYmxlQ2VsbFN0eWxlUHJvcGVydHkifV19fQ==")), "rowFieldNamesStyle") unless @row_field_names_style.nil?
  @row_header_style = row_header_style.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::TableCellStyleProperty.new(**row_header_style.transform_keys(&:to_sym)) : row_header_style
  Jsii::Type.check_type(@row_header_style, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlRhYmxlQ2VsbFN0eWxlUHJvcGVydHkifV19fQ==")), "rowHeaderStyle") unless @row_header_style.nil?
  @rows_label_options = rows_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::PivotTableRowsLabelOptionsProperty.new(**rows_label_options.transform_keys(&:to_sym)) : rows_label_options
  Jsii::Type.check_type(@rows_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlBpdm90VGFibGVSb3dzTGFiZWxPcHRpb25zUHJvcGVydHkifV19fQ==")), "rowsLabelOptions") unless @rows_label_options.nil?
  @rows_layout = rows_layout
  Jsii::Type.check_type(@rows_layout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "rowsLayout") unless @rows_layout.nil?
  @single_metric_visibility = single_metric_visibility
  Jsii::Type.check_type(@single_metric_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "singleMetricVisibility") unless @single_metric_visibility.nil?
  @toggle_buttons_visibility = toggle_buttons_visibility
  Jsii::Type.check_type(@toggle_buttons_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "toggleButtonsVisibility") unless @toggle_buttons_visibility.nil?
end

Instance Attribute Details

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

The table cell style of cells.

Returns:

See Also:



22260
22261
22262
 
# File 'quick_sight/cfn_analysis.rb', line 22260

def cell_style
  @cell_style
end

#collapsed_row_dimensions_visibility ⇒ String? (readonly)

The visibility setting of a pivot table's collapsed row dimension fields.

If the value of this structure is HIDDEN , all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE .

Returns:

  • (String, nil)

See Also:



22267
22268
22269
 
# File 'quick_sight/cfn_analysis.rb', line 22267

def collapsed_row_dimensions_visibility
  @collapsed_row_dimensions_visibility
end

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

The table cell style of the column header.

Returns:

See Also:



22272
22273
22274
 
# File 'quick_sight/cfn_analysis.rb', line 22272

def column_header_style
  @column_header_style
end

#column_names_visibility ⇒ String? (readonly)

The visibility of the column names.

Returns:

  • (String, nil)

See Also:



22277
22278
22279
 
# File 'quick_sight/cfn_analysis.rb', line 22277

def column_names_visibility
  @column_names_visibility
end

#default_cell_width ⇒ String? (readonly)

The default cell width of the pivot table.

Returns:

  • (String, nil)

See Also:



22282
22283
22284
 
# File 'quick_sight/cfn_analysis.rb', line 22282

def default_cell_width
  @default_cell_width
end

#metric_placement ⇒ String? (readonly)

The metric placement (row, column) options.

Returns:

  • (String, nil)

See Also:



22287
22288
22289
 
# File 'quick_sight/cfn_analysis.rb', line 22287

def metric_placement
  @metric_placement
end

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

The row alternate color options (widget status, row alternate colors).

Returns:

See Also:



22292
22293
22294
 
# File 'quick_sight/cfn_analysis.rb', line 22292

def row_alternate_color_options
  @row_alternate_color_options
end

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

The table cell style of row field names.

Returns:

See Also:



22297
22298
22299
 
# File 'quick_sight/cfn_analysis.rb', line 22297

def row_field_names_style
  @row_field_names_style
end

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

The table cell style of the row headers.

Returns:

See Also:



22302
22303
22304
 
# File 'quick_sight/cfn_analysis.rb', line 22302

def row_header_style
  @row_header_style
end

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

The options for the label that is located above the row headers.

This option is only applicable when RowsLayout is set to HIERARCHY .

Returns:

See Also:



22309
22310
22311
 
# File 'quick_sight/cfn_analysis.rb', line 22309

def rows_label_options
  @rows_label_options
end

#rows_layout ⇒ String? (readonly)

The layout for the row dimension headers of a pivot table. Choose one of the following options.

  • TABULAR : (Default) Each row field is displayed in a separate column.
  • HIERARCHY : All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.

Returns:

  • (String, nil)

See Also:



22317
22318
22319
 
# File 'quick_sight/cfn_analysis.rb', line 22317

def rows_layout
  @rows_layout
end

#single_metric_visibility ⇒ String? (readonly)

The visibility of the single metric options.

Returns:

  • (String, nil)

See Also:



22322
22323
22324
 
# File 'quick_sight/cfn_analysis.rb', line 22322

def single_metric_visibility
  @single_metric_visibility
end

#toggle_buttons_visibility ⇒ String? (readonly)

Determines the visibility of the pivot table.

Returns:

  • (String, nil)

See Also:



22327
22328
22329
 
# File 'quick_sight/cfn_analysis.rb', line 22327

def toggle_buttons_visibility
  @toggle_buttons_visibility
end

Class Method Details

.jsii_properties ⇒ Object 



22329
22330
22331
22332
22333
22334
22335
22336
22337
22338
22339
22340
22341
22342
22343
22344
22345
 
# File 'quick_sight/cfn_analysis.rb', line 22329

def self.jsii_properties
  {
    :cell_style => "cellStyle",
    :collapsed_row_dimensions_visibility => "collapsedRowDimensionsVisibility",
    :column_header_style => "columnHeaderStyle",
    :column_names_visibility => "columnNamesVisibility",
    :default_cell_width => "defaultCellWidth",
    :metric_placement => "metricPlacement",
    :row_alternate_color_options => "rowAlternateColorOptions",
    :row_field_names_style => "rowFieldNamesStyle",
    :row_header_style => "rowHeaderStyle",
    :rows_label_options => "rowsLabelOptions",
    :rows_layout => "rowsLayout",
    :single_metric_visibility => "singleMetricVisibility",
    :toggle_buttons_visibility => "toggleButtonsVisibility",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



22347
22348
22349
22350
22351
22352
22353
22354
22355
22356
22357
22358
22359
22360
22361
22362
22363
22364
22365
 
# File 'quick_sight/cfn_analysis.rb', line 22347

def to_jsii
  result = {}
  result.merge!({
    "cellStyle" => @cell_style,
    "collapsedRowDimensionsVisibility" => @collapsed_row_dimensions_visibility,
    "columnHeaderStyle" => @column_header_style,
    "columnNamesVisibility" => @column_names_visibility,
    "defaultCellWidth" => @default_cell_width,
    "metricPlacement" => @metric_placement,
    "rowAlternateColorOptions" => @row_alternate_color_options,
    "rowFieldNamesStyle" => @row_field_names_style,
    "rowHeaderStyle" => @row_header_style,
    "rowsLabelOptions" => @rows_label_options,
    "rowsLayout" => @rows_layout,
    "singleMetricVisibility" => @single_metric_visibility,
    "toggleButtonsVisibility" => @toggle_buttons_visibility,
  })
  result.compact
end