Class: AWSCDK::QuickSight::CfnTemplate::BoxPlotChartConfigurationProperty

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

Overview

The configuration of a BoxPlotVisual .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(box_plot_options: nil, category_axis: nil, category_label_options: nil, field_wells: nil, interactions: nil, legend: nil, primary_y_axis_display_options: nil, primary_y_axis_label_options: nil, reference_lines: nil, sort_configuration: nil, tooltip: nil, visual_palette: nil) ⇒ BoxPlotChartConfigurationProperty

Returns a new instance of BoxPlotChartConfigurationProperty.

Parameters:



2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
 
# File 'quick_sight/cfn_template.rb', line 2604

def initialize(box_plot_options: nil, category_axis: nil, category_label_options: nil, field_wells: nil, interactions: nil, legend: nil, primary_y_axis_display_options: nil, primary_y_axis_label_options: nil, reference_lines: nil, sort_configuration: nil, tooltip: nil, visual_palette: nil)
  @box_plot_options = box_plot_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::BoxPlotOptionsProperty.new(**box_plot_options.transform_keys(&:to_sym)) : box_plot_options
  Jsii::Type.check_type(@box_plot_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkJveFBsb3RPcHRpb25zUHJvcGVydHkifV19fQ==")), "boxPlotOptions") unless @box_plot_options.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?
  @field_wells = field_wells.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::BoxPlotFieldWellsProperty.new(**field_wells.transform_keys(&:to_sym)) : field_wells
  Jsii::Type.check_type(@field_wells, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkJveFBsb3RGaWVsZFdlbGxzUHJvcGVydHkifV19fQ==")), "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?
  @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?
  @sort_configuration = sort_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::BoxPlotSortConfigurationProperty.new(**sort_configuration.transform_keys(&:to_sym)) : sort_configuration
  Jsii::Type.check_type(@sort_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkJveFBsb3RTb3J0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "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

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

The box plot chart options for a box plot visual.

Returns:

See Also:



2635
2636
2637
 
# File 'quick_sight/cfn_template.rb', line 2635

def box_plot_options
  @box_plot_options
end

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

The label display options (grid line, range, scale, axis step) of a box plot category.

Returns:

See Also:



2640
2641
2642
 
# File 'quick_sight/cfn_template.rb', line 2640

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 box plot category.

Returns:

See Also:



2645
2646
2647
 
# File 'quick_sight/cfn_template.rb', line 2645

def category_label_options
  @category_label_options
end

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

The field wells of the visual.

Returns:

See Also:



2650
2651
2652
 
# File 'quick_sight/cfn_template.rb', line 2650

def field_wells
  @field_wells
end

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

The general visual interactions setup for a visual.

Returns:

See Also:



2655
2656
2657
 
# File 'quick_sight/cfn_template.rb', line 2655

def interactions
  @interactions
end

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

Returns:

See Also:



2658
2659
2660
 
# File 'quick_sight/cfn_template.rb', line 2658

def legend
  @legend
end

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

The label display options (grid line, range, scale, axis step) of a box plot category.

Returns:

See Also:



2663
2664
2665
 
# File 'quick_sight/cfn_template.rb', line 2663

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 box plot value.

Returns:

See Also:



2668
2669
2670
 
# File 'quick_sight/cfn_template.rb', line 2668

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:



2673
2674
2675
 
# File 'quick_sight/cfn_template.rb', line 2673

def reference_lines
  @reference_lines
end

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

The sort configuration of a BoxPlotVisual .

Returns:

See Also:



2678
2679
2680
 
# File 'quick_sight/cfn_template.rb', line 2678

def sort_configuration
  @sort_configuration
end

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

The tooltip display setup of the visual.

Returns:

See Also:



2683
2684
2685
 
# File 'quick_sight/cfn_template.rb', line 2683

def tooltip
  @tooltip
end

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

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

Returns:

See Also:



2688
2689
2690
 
# File 'quick_sight/cfn_template.rb', line 2688

def visual_palette
  @visual_palette
end

Class Method Details

.jsii_properties ⇒ Object 



2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
 
# File 'quick_sight/cfn_template.rb', line 2690

def self.jsii_properties
  {
    :box_plot_options => "boxPlotOptions",
    :category_axis => "categoryAxis",
    :category_label_options => "categoryLabelOptions",
    :field_wells => "fieldWells",
    :interactions => "interactions",
    :legend => "legend",
    :primary_y_axis_display_options => "primaryYAxisDisplayOptions",
    :primary_y_axis_label_options => "primaryYAxisLabelOptions",
    :reference_lines => "referenceLines",
    :sort_configuration => "sortConfiguration",
    :tooltip => "tooltip",
    :visual_palette => "visualPalette",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
 
# File 'quick_sight/cfn_template.rb', line 2707

def to_jsii
  result = {}
  result.merge!({
    "boxPlotOptions" => @box_plot_options,
    "categoryAxis" => @category_axis,
    "categoryLabelOptions" => @category_label_options,
    "fieldWells" => @field_wells,
    "interactions" => @interactions,
    "legend" => @legend,
    "primaryYAxisDisplayOptions" => @primary_y_axis_display_options,
    "primaryYAxisLabelOptions" => @primary_y_axis_label_options,
    "referenceLines" => @reference_lines,
    "sortConfiguration" => @sort_configuration,
    "tooltip" => @tooltip,
    "visualPalette" => @visual_palette,
  })
  result.compact
end