Class: AWSCDK::QuickSight::CfnAnalysis::ComboChartConfigurationProperty

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

Overview

The configuration of a ComboChartVisual .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bar_data_labels: nil, bars_arrangement: nil, category_axis: nil, category_label_options: nil, color_label_options: nil, field_wells: nil, interactions: nil, legend: nil, line_data_labels: nil, primary_y_axis_display_options: nil, primary_y_axis_label_options: nil, reference_lines: nil, secondary_y_axis_display_options: nil, secondary_y_axis_label_options: nil, single_axis_options: nil, sort_configuration: nil, tooltip: nil, visual_palette: nil) ⇒ ComboChartConfigurationProperty

Returns a new instance of ComboChartConfigurationProperty.

Parameters:



4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
 
# File 'quick_sight/cfn_analysis.rb', line 4364

def initialize(bar_data_labels: nil, bars_arrangement: nil, category_axis: nil, category_label_options: nil, color_label_options: nil, field_wells: nil, interactions: nil, legend: nil, line_data_labels: nil, primary_y_axis_display_options: nil, primary_y_axis_label_options: nil, reference_lines: nil, secondary_y_axis_display_options: nil, secondary_y_axis_label_options: nil, single_axis_options: nil, sort_configuration: nil, tooltip: nil, visual_palette: nil)
  @bar_data_labels = bar_data_labels.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::DataLabelOptionsProperty.new(**bar_data_labels.transform_keys(&:to_sym)) : bar_data_labels
  Jsii::Type.check_type(@bar_data_labels, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkRhdGFMYWJlbE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "barDataLabels") unless @bar_data_labels.nil?
  @bars_arrangement = bars_arrangement
  Jsii::Type.check_type(@bars_arrangement, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "barsArrangement") unless @bars_arrangement.nil?
  @category_axis = category_axis.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::AxisDisplayOptionsProperty.new(**category_axis.transform_keys(&:to_sym)) : category_axis
  Jsii::Type.check_type(@category_axis, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkF4aXNEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "categoryAxis") unless @category_axis.nil?
  @category_label_options = category_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ChartAxisLabelOptionsProperty.new(**category_label_options.transform_keys(&:to_sym)) : category_label_options
  Jsii::Type.check_type(@category_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "categoryLabelOptions") unless @category_label_options.nil?
  @color_label_options = color_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ChartAxisLabelOptionsProperty.new(**color_label_options.transform_keys(&:to_sym)) : color_label_options
  Jsii::Type.check_type(@color_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "colorLabelOptions") unless @color_label_options.nil?
  @field_wells = field_wells.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ComboChartFieldWellsProperty.new(**field_wells.transform_keys(&:to_sym)) : field_wells
  Jsii::Type.check_type(@field_wells, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkNvbWJvQ2hhcnRGaWVsZFdlbGxzUHJvcGVydHkifV19fQ==")), "fieldWells") unless @field_wells.nil?
  @interactions = interactions.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::VisualInteractionOptionsProperty.new(**interactions.transform_keys(&:to_sym)) : interactions
  Jsii::Type.check_type(@interactions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlZpc3VhbEludGVyYWN0aW9uT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "interactions") unless @interactions.nil?
  @legend = legend.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::LegendOptionsProperty.new(**legend.transform_keys(&:to_sym)) : legend
  Jsii::Type.check_type(@legend, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkxlZ2VuZE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "legend") unless @legend.nil?
  @line_data_labels = line_data_labels.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::DataLabelOptionsProperty.new(**line_data_labels.transform_keys(&:to_sym)) : line_data_labels
  Jsii::Type.check_type(@line_data_labels, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkRhdGFMYWJlbE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "lineDataLabels") unless @line_data_labels.nil?
  @primary_y_axis_display_options = primary_y_axis_display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::AxisDisplayOptionsProperty.new(**primary_y_axis_display_options.transform_keys(&:to_sym)) : primary_y_axis_display_options
  Jsii::Type.check_type(@primary_y_axis_display_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkF4aXNEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "primaryYAxisDisplayOptions") unless @primary_y_axis_display_options.nil?
  @primary_y_axis_label_options = primary_y_axis_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ChartAxisLabelOptionsProperty.new(**primary_y_axis_label_options.transform_keys(&:to_sym)) : primary_y_axis_label_options
  Jsii::Type.check_type(@primary_y_axis_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "primaryYAxisLabelOptions") unless @primary_y_axis_label_options.nil?
  @reference_lines = reference_lines
  Jsii::Type.check_type(@reference_lines, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5SZWZlcmVuY2VMaW5lUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "referenceLines") unless @reference_lines.nil?
  @secondary_y_axis_display_options = secondary_y_axis_display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::AxisDisplayOptionsProperty.new(**secondary_y_axis_display_options.transform_keys(&:to_sym)) : secondary_y_axis_display_options
  Jsii::Type.check_type(@secondary_y_axis_display_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkF4aXNEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "secondaryYAxisDisplayOptions") unless @secondary_y_axis_display_options.nil?
  @secondary_y_axis_label_options = secondary_y_axis_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ChartAxisLabelOptionsProperty.new(**secondary_y_axis_label_options.transform_keys(&:to_sym)) : secondary_y_axis_label_options
  Jsii::Type.check_type(@secondary_y_axis_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "secondaryYAxisLabelOptions") unless @secondary_y_axis_label_options.nil?
  @single_axis_options = single_axis_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::SingleAxisOptionsProperty.new(**single_axis_options.transform_keys(&:to_sym)) : single_axis_options
  Jsii::Type.check_type(@single_axis_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlNpbmdsZUF4aXNPcHRpb25zUHJvcGVydHkifV19fQ==")), "singleAxisOptions") unless @single_axis_options.nil?
  @sort_configuration = sort_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ComboChartSortConfigurationProperty.new(**sort_configuration.transform_keys(&:to_sym)) : sort_configuration
  Jsii::Type.check_type(@sort_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkNvbWJvQ2hhcnRTb3J0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "sortConfiguration") unless @sort_configuration.nil?
  @tooltip = tooltip.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::TooltipOptionsProperty.new(**tooltip.transform_keys(&:to_sym)) : tooltip
  Jsii::Type.check_type(@tooltip, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlRvb2x0aXBPcHRpb25zUHJvcGVydHkifV19fQ==")), "tooltip") unless @tooltip.nil?
  @visual_palette = visual_palette.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::VisualPaletteProperty.new(**visual_palette.transform_keys(&:to_sym)) : visual_palette
  Jsii::Type.check_type(@visual_palette, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlZpc3VhbFBhbGV0dGVQcm9wZXJ0eSJ9XX19")), "visualPalette") unless @visual_palette.nil?
end

Instance Attribute Details

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

The options that determine if visual data labels are displayed.

The data label options for a bar in a combo chart.

Returns:

See Also:



4409
4410
4411
 
# File 'quick_sight/cfn_analysis.rb', line 4409

def bar_data_labels
  @bar_data_labels
end

#bars_arrangement ⇒ String? (readonly)

Determines the bar arrangement in a combo chart. The following are valid values in this structure:.

  • CLUSTERED : For clustered bar combo charts.
  • STACKED : For stacked bar combo charts.
  • STACKED_PERCENT : Do not use. If you use this value, the operation returns a validation error.

Returns:

  • (String, nil)

See Also:



4418
4419
4420
 
# File 'quick_sight/cfn_analysis.rb', line 4418

def bars_arrangement
  @bars_arrangement
end

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

The category axis of a combo chart.

Returns:

See Also:



4423
4424
4425
 
# File 'quick_sight/cfn_analysis.rb', line 4423

def category_axis
  @category_axis
end

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

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

Returns:

See Also:



4428
4429
4430
 
# File 'quick_sight/cfn_analysis.rb', line 4428

def category_label_options
  @category_label_options
end

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

The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.

Returns:

See Also:



4433
4434
4435
 
# File 'quick_sight/cfn_analysis.rb', line 4433

def color_label_options
  @color_label_options
end

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

The field wells of the visual.

Returns:

See Also:



4438
4439
4440
 
# File 'quick_sight/cfn_analysis.rb', line 4438

def field_wells
  @field_wells
end

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

The general visual interactions setup for a visual.

Returns:

See Also:



4443
4444
4445
 
# File 'quick_sight/cfn_analysis.rb', line 4443

def interactions
  @interactions
end

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

The legend display setup of the visual.

Returns:

See Also:



4448
4449
4450
 
# File 'quick_sight/cfn_analysis.rb', line 4448

def legend
  @legend
end

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

The options that determine if visual data labels are displayed.

The data label options for a line in a combo chart.

Returns:

See Also:



4455
4456
4457
 
# File 'quick_sight/cfn_analysis.rb', line 4455

def line_data_labels
  @line_data_labels
end

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

The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.

Returns:

See Also:



4460
4461
4462
 
# File 'quick_sight/cfn_analysis.rb', line 4460

def primary_y_axis_display_options
  @primary_y_axis_display_options
end

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

The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.

Returns:

See Also:



4465
4466
4467
 
# File 'quick_sight/cfn_analysis.rb', line 4465

def primary_y_axis_label_options
  @primary_y_axis_label_options
end

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

The reference line setup of the visual.

Returns:

See Also:



4470
4471
4472
 
# File 'quick_sight/cfn_analysis.rb', line 4470

def reference_lines
  @reference_lines
end

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

The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.

Returns:

See Also:



4475
4476
4477
 
# File 'quick_sight/cfn_analysis.rb', line 4475

def secondary_y_axis_display_options
  @secondary_y_axis_display_options
end

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

The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.

Returns:

See Also:



4480
4481
4482
 
# File 'quick_sight/cfn_analysis.rb', line 4480

def secondary_y_axis_label_options
  @secondary_y_axis_label_options
end

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

Returns:

See Also:



4483
4484
4485
 
# File 'quick_sight/cfn_analysis.rb', line 4483

def single_axis_options
  @single_axis_options
end

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

The sort configuration of a ComboChartVisual .

Returns:

See Also:



4488
4489
4490
 
# File 'quick_sight/cfn_analysis.rb', line 4488

def sort_configuration
  @sort_configuration
end

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

The legend display setup of the visual.

Returns:

See Also:



4493
4494
4495
 
# File 'quick_sight/cfn_analysis.rb', line 4493

def tooltip
  @tooltip
end

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

The palette (chart color) display setup of the visual.

Returns:

See Also:



4498
4499
4500
 
# File 'quick_sight/cfn_analysis.rb', line 4498

def visual_palette
  @visual_palette
end

Class Method Details

.jsii_properties ⇒ Object 



4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
 
# File 'quick_sight/cfn_analysis.rb', line 4500

def self.jsii_properties
  {
    :bar_data_labels => "barDataLabels",
    :bars_arrangement => "barsArrangement",
    :category_axis => "categoryAxis",
    :category_label_options => "categoryLabelOptions",
    :color_label_options => "colorLabelOptions",
    :field_wells => "fieldWells",
    :interactions => "interactions",
    :legend => "legend",
    :line_data_labels => "lineDataLabels",
    :primary_y_axis_display_options => "primaryYAxisDisplayOptions",
    :primary_y_axis_label_options => "primaryYAxisLabelOptions",
    :reference_lines => "referenceLines",
    :secondary_y_axis_display_options => "secondaryYAxisDisplayOptions",
    :secondary_y_axis_label_options => "secondaryYAxisLabelOptions",
    :single_axis_options => "singleAxisOptions",
    :sort_configuration => "sortConfiguration",
    :tooltip => "tooltip",
    :visual_palette => "visualPalette",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
 
# File 'quick_sight/cfn_analysis.rb', line 4523

def to_jsii
  result = {}
  result.merge!({
    "barDataLabels" => @bar_data_labels,
    "barsArrangement" => @bars_arrangement,
    "categoryAxis" => @category_axis,
    "categoryLabelOptions" => @category_label_options,
    "colorLabelOptions" => @color_label_options,
    "fieldWells" => @field_wells,
    "interactions" => @interactions,
    "legend" => @legend,
    "lineDataLabels" => @line_data_labels,
    "primaryYAxisDisplayOptions" => @primary_y_axis_display_options,
    "primaryYAxisLabelOptions" => @primary_y_axis_label_options,
    "referenceLines" => @reference_lines,
    "secondaryYAxisDisplayOptions" => @secondary_y_axis_display_options,
    "secondaryYAxisLabelOptions" => @secondary_y_axis_label_options,
    "singleAxisOptions" => @single_axis_options,
    "sortConfiguration" => @sort_configuration,
    "tooltip" => @tooltip,
    "visualPalette" => @visual_palette,
  })
  result.compact
end