Class: AWSCDK::QuickSight::CfnTemplate::ComboChartConfigurationProperty

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



4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
 
# File 'quick_sight/cfn_template.rb', line 4215

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::CfnTemplate::DataLabelOptionsProperty.new(**bar_data_labels.transform_keys(&:to_sym)) : bar_data_labels
  Jsii::Type.check_type(@bar_data_labels, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkRhdGFMYWJlbE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "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::CfnTemplate::AxisDisplayOptionsProperty.new(**category_axis.transform_keys(&:to_sym)) : category_axis
  Jsii::Type.check_type(@category_axis, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkF4aXNEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "categoryAxis") unless @category_axis.nil?
  @category_label_options = category_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ChartAxisLabelOptionsProperty.new(**category_label_options.transform_keys(&:to_sym)) : category_label_options
  Jsii::Type.check_type(@category_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "categoryLabelOptions") unless @category_label_options.nil?
  @color_label_options = color_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ChartAxisLabelOptionsProperty.new(**color_label_options.transform_keys(&:to_sym)) : color_label_options
  Jsii::Type.check_type(@color_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "colorLabelOptions") unless @color_label_options.nil?
  @field_wells = field_wells.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ComboChartFieldWellsProperty.new(**field_wells.transform_keys(&:to_sym)) : field_wells
  Jsii::Type.check_type(@field_wells, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNvbWJvQ2hhcnRGaWVsZFdlbGxzUHJvcGVydHkifV19fQ==")), "fieldWells") unless @field_wells.nil?
  @interactions = interactions.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::VisualInteractionOptionsProperty.new(**interactions.transform_keys(&:to_sym)) : interactions
  Jsii::Type.check_type(@interactions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlZpc3VhbEludGVyYWN0aW9uT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "interactions") unless @interactions.nil?
  @legend = legend.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::LegendOptionsProperty.new(**legend.transform_keys(&:to_sym)) : legend
  Jsii::Type.check_type(@legend, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkxlZ2VuZE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "legend") unless @legend.nil?
  @line_data_labels = line_data_labels.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::DataLabelOptionsProperty.new(**line_data_labels.transform_keys(&:to_sym)) : line_data_labels
  Jsii::Type.check_type(@line_data_labels, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkRhdGFMYWJlbE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "lineDataLabels") unless @line_data_labels.nil?
  @primary_y_axis_display_options = primary_y_axis_display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkF4aXNEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "primaryYAxisDisplayOptions") unless @primary_y_axis_display_options.nil?
  @primary_y_axis_label_options = primary_y_axis_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "primaryYAxisLabelOptions") unless @primary_y_axis_label_options.nil?
  @reference_lines = reference_lines
  Jsii::Type.check_type(@reference_lines, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5SZWZlcmVuY2VMaW5lUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "referenceLines") unless @reference_lines.nil?
  @secondary_y_axis_display_options = secondary_y_axis_display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkF4aXNEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "secondaryYAxisDisplayOptions") unless @secondary_y_axis_display_options.nil?
  @secondary_y_axis_label_options = secondary_y_axis_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "secondaryYAxisLabelOptions") unless @secondary_y_axis_label_options.nil?
  @single_axis_options = single_axis_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::SingleAxisOptionsProperty.new(**single_axis_options.transform_keys(&:to_sym)) : single_axis_options
  Jsii::Type.check_type(@single_axis_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlNpbmdsZUF4aXNPcHRpb25zUHJvcGVydHkifV19fQ==")), "singleAxisOptions") unless @single_axis_options.nil?
  @sort_configuration = sort_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ComboChartSortConfigurationProperty.new(**sort_configuration.transform_keys(&:to_sym)) : sort_configuration
  Jsii::Type.check_type(@sort_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNvbWJvQ2hhcnRTb3J0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "sortConfiguration") unless @sort_configuration.nil?
  @tooltip = tooltip.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::TooltipOptionsProperty.new(**tooltip.transform_keys(&:to_sym)) : tooltip
  Jsii::Type.check_type(@tooltip, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRvb2x0aXBPcHRpb25zUHJvcGVydHkifV19fQ==")), "tooltip") unless @tooltip.nil?
  @visual_palette = visual_palette.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::VisualPaletteProperty.new(**visual_palette.transform_keys(&:to_sym)) : visual_palette
  Jsii::Type.check_type(@visual_palette, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlZpc3VhbFBhbGV0dGVQcm9wZXJ0eSJ9XX19")), "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:



4260
4261
4262
 
# File 'quick_sight/cfn_template.rb', line 4260

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:



4269
4270
4271
 
# File 'quick_sight/cfn_template.rb', line 4269

def bars_arrangement
  @bars_arrangement
end

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

The category axis of a combo chart.

Returns:

See Also:



4274
4275
4276
 
# File 'quick_sight/cfn_template.rb', line 4274

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:



4279
4280
4281
 
# File 'quick_sight/cfn_template.rb', line 4279

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:



4284
4285
4286
 
# File 'quick_sight/cfn_template.rb', line 4284

def color_label_options
  @color_label_options
end

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

The field wells of the visual.

Returns:

See Also:



4289
4290
4291
 
# File 'quick_sight/cfn_template.rb', line 4289

def field_wells
  @field_wells
end

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

The general visual interactions setup for a visual.

Returns:

See Also:



4294
4295
4296
 
# File 'quick_sight/cfn_template.rb', line 4294

def interactions
  @interactions
end

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

The legend display setup of the visual.

Returns:

See Also:



4299
4300
4301
 
# File 'quick_sight/cfn_template.rb', line 4299

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:



4306
4307
4308
 
# File 'quick_sight/cfn_template.rb', line 4306

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:



4311
4312
4313
 
# File 'quick_sight/cfn_template.rb', line 4311

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:



4316
4317
4318
 
# File 'quick_sight/cfn_template.rb', line 4316

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:



4321
4322
4323
 
# File 'quick_sight/cfn_template.rb', line 4321

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:



4326
4327
4328
 
# File 'quick_sight/cfn_template.rb', line 4326

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:



4331
4332
4333
 
# File 'quick_sight/cfn_template.rb', line 4331

def secondary_y_axis_label_options
  @secondary_y_axis_label_options
end

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

Returns:

See Also:



4334
4335
4336
 
# File 'quick_sight/cfn_template.rb', line 4334

def single_axis_options
  @single_axis_options
end

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

The sort configuration of a ComboChartVisual .

Returns:

See Also:



4339
4340
4341
 
# File 'quick_sight/cfn_template.rb', line 4339

def sort_configuration
  @sort_configuration
end

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

The legend display setup of the visual.

Returns:

See Also:



4344
4345
4346
 
# File 'quick_sight/cfn_template.rb', line 4344

def tooltip
  @tooltip
end

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

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

Returns:

See Also:



4349
4350
4351
 
# File 'quick_sight/cfn_template.rb', line 4349

def visual_palette
  @visual_palette
end

Class Method Details

.jsii_properties ⇒ Object 



4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
 
# File 'quick_sight/cfn_template.rb', line 4351

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 



4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
 
# File 'quick_sight/cfn_template.rb', line 4374

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