Class: AWSCDK::QuickSight::CfnTemplate::PivotTableOptionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_template.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:



20353
20354
20355
20356
20357
20358
20359
20360
20361
20362
20363
20364
20365
20366
20367
20368
20369
20370
20371
20372
20373
20374
20375
20376
20377
20378
20379
20380
 
# File 'quick_sight/cfn_template.rb', line 20353

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::CfnTemplate::TableCellStyleProperty.new(**cell_style.transform_keys(&:to_sym)) : cell_style
  Jsii::Type.check_type(@cell_style, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRhYmxlQ2VsbFN0eWxlUHJvcGVydHkifV19fQ==")), "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::CfnTemplate::TableCellStyleProperty.new(**column_header_style.transform_keys(&:to_sym)) : column_header_style
  Jsii::Type.check_type(@column_header_style, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRhYmxlQ2VsbFN0eWxlUHJvcGVydHkifV19fQ==")), "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::CfnTemplate::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlJvd0FsdGVybmF0ZUNvbG9yT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "rowAlternateColorOptions") unless @row_alternate_color_options.nil?
  @row_field_names_style = row_field_names_style.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRhYmxlQ2VsbFN0eWxlUHJvcGVydHkifV19fQ==")), "rowFieldNamesStyle") unless @row_field_names_style.nil?
  @row_header_style = row_header_style.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::TableCellStyleProperty.new(**row_header_style.transform_keys(&:to_sym)) : row_header_style
  Jsii::Type.check_type(@row_header_style, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRhYmxlQ2VsbFN0eWxlUHJvcGVydHkifV19fQ==")), "rowHeaderStyle") unless @row_header_style.nil?
  @rows_label_options = rows_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::PivotTableRowsLabelOptionsProperty.new(**rows_label_options.transform_keys(&:to_sym)) : rows_label_options
  Jsii::Type.check_type(@rows_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlBpdm90VGFibGVSb3dzTGFiZWxPcHRpb25zUHJvcGVydHkifV19fQ==")), "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:



20386
20387
20388
 
# File 'quick_sight/cfn_template.rb', line 20386

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:



20393
20394
20395
 
# File 'quick_sight/cfn_template.rb', line 20393

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:



20398
20399
20400
 
# File 'quick_sight/cfn_template.rb', line 20398

def column_header_style
  @column_header_style
end

#column_names_visibility ⇒ String? (readonly)

The visibility of the column names.

Returns:

  • (String, nil)

See Also:



20403
20404
20405
 
# File 'quick_sight/cfn_template.rb', line 20403

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:



20408
20409
20410
 
# File 'quick_sight/cfn_template.rb', line 20408

def default_cell_width
  @default_cell_width
end

#metric_placement ⇒ String? (readonly)

The metric placement (row, column) options.

Returns:

  • (String, nil)

See Also:



20413
20414
20415
 
# File 'quick_sight/cfn_template.rb', line 20413

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:



20418
20419
20420
 
# File 'quick_sight/cfn_template.rb', line 20418

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:



20423
20424
20425
 
# File 'quick_sight/cfn_template.rb', line 20423

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:



20428
20429
20430
 
# File 'quick_sight/cfn_template.rb', line 20428

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:



20435
20436
20437
 
# File 'quick_sight/cfn_template.rb', line 20435

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:



20443
20444
20445
 
# File 'quick_sight/cfn_template.rb', line 20443

def rows_layout
  @rows_layout
end

#single_metric_visibility ⇒ String? (readonly)

The visibility of the single metric options.

Returns:

  • (String, nil)

See Also:



20448
20449
20450
 
# File 'quick_sight/cfn_template.rb', line 20448

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:



20453
20454
20455
 
# File 'quick_sight/cfn_template.rb', line 20453

def toggle_buttons_visibility
  @toggle_buttons_visibility
end

Class Method Details

.jsii_properties ⇒ Object 



20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
20469
20470
20471
 
# File 'quick_sight/cfn_template.rb', line 20455

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 



20473
20474
20475
20476
20477
20478
20479
20480
20481
20482
20483
20484
20485
20486
20487
20488
20489
20490
20491
 
# File 'quick_sight/cfn_template.rb', line 20473

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