Class: AWSCDK::QuickSight::CfnDashboard::BoxPlotChartConfigurationProperty

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



2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
 
# File 'quick_sight/cfn_dashboard.rb', line 2748

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::CfnDashboard::BoxPlotOptionsProperty.new(**box_plot_options.transform_keys(&:to_sym)) : box_plot_options
  Jsii::Type.check_type(@box_plot_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Cb3hQbG90T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "boxPlotOptions") unless @box_plot_options.nil?
  @category_axis = category_axis.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::AxisDisplayOptionsProperty.new(**category_axis.transform_keys(&:to_sym)) : category_axis
  Jsii::Type.check_type(@category_axis, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5BeGlzRGlzcGxheU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "categoryAxis") unless @category_axis.nil?
  @category_label_options = category_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ChartAxisLabelOptionsProperty.new(**category_label_options.transform_keys(&:to_sym)) : category_label_options
  Jsii::Type.check_type(@category_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5DaGFydEF4aXNMYWJlbE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "categoryLabelOptions") unless @category_label_options.nil?
  @field_wells = field_wells.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::BoxPlotFieldWellsProperty.new(**field_wells.transform_keys(&:to_sym)) : field_wells
  Jsii::Type.check_type(@field_wells, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Cb3hQbG90RmllbGRXZWxsc1Byb3BlcnR5In1dfX0=")), "fieldWells") unless @field_wells.nil?
  @interactions = interactions.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::VisualInteractionOptionsProperty.new(**interactions.transform_keys(&:to_sym)) : interactions
  Jsii::Type.check_type(@interactions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5WaXN1YWxJbnRlcmFjdGlvbk9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "interactions") unless @interactions.nil?
  @legend = legend.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::LegendOptionsProperty.new(**legend.transform_keys(&:to_sym)) : legend
  Jsii::Type.check_type(@legend, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5MZWdlbmRPcHRpb25zUHJvcGVydHkifV19fQ==")), "legend") unless @legend.nil?
  @primary_y_axis_display_options = primary_y_axis_display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5BeGlzRGlzcGxheU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "primaryYAxisDisplayOptions") unless @primary_y_axis_display_options.nil?
  @primary_y_axis_label_options = primary_y_axis_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5DaGFydEF4aXNMYWJlbE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "primaryYAxisLabelOptions") unless @primary_y_axis_label_options.nil?
  @reference_lines = reference_lines
  Jsii::Type.check_type(@reference_lines, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuUmVmZXJlbmNlTGluZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "referenceLines") unless @reference_lines.nil?
  @sort_configuration = sort_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::BoxPlotSortConfigurationProperty.new(**sort_configuration.transform_keys(&:to_sym)) : sort_configuration
  Jsii::Type.check_type(@sort_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Cb3hQbG90U29ydENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "sortConfiguration") unless @sort_configuration.nil?
  @tooltip = tooltip.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::TooltipOptionsProperty.new(**tooltip.transform_keys(&:to_sym)) : tooltip
  Jsii::Type.check_type(@tooltip, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Ub29sdGlwT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "tooltip") unless @tooltip.nil?
  @visual_palette = visual_palette.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::VisualPaletteProperty.new(**visual_palette.transform_keys(&:to_sym)) : visual_palette
  Jsii::Type.check_type(@visual_palette, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5WaXN1YWxQYWxldHRlUHJvcGVydHkifV19fQ==")), "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:



2779
2780
2781
 
# File 'quick_sight/cfn_dashboard.rb', line 2779

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:



2784
2785
2786
 
# File 'quick_sight/cfn_dashboard.rb', line 2784

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:



2789
2790
2791
 
# File 'quick_sight/cfn_dashboard.rb', line 2789

def category_label_options
  @category_label_options
end

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

The field wells of the visual.

Returns:

See Also:



2794
2795
2796
 
# File 'quick_sight/cfn_dashboard.rb', line 2794

def field_wells
  @field_wells
end

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

The general visual interactions setup for a visual.

Returns:

See Also:



2799
2800
2801
 
# File 'quick_sight/cfn_dashboard.rb', line 2799

def interactions
  @interactions
end

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

Returns:

See Also:



2802
2803
2804
 
# File 'quick_sight/cfn_dashboard.rb', line 2802

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:



2807
2808
2809
 
# File 'quick_sight/cfn_dashboard.rb', line 2807

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:



2812
2813
2814
 
# File 'quick_sight/cfn_dashboard.rb', line 2812

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:



2817
2818
2819
 
# File 'quick_sight/cfn_dashboard.rb', line 2817

def reference_lines
  @reference_lines
end

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

The sort configuration of a BoxPlotVisual .

Returns:

See Also:



2822
2823
2824
 
# File 'quick_sight/cfn_dashboard.rb', line 2822

def sort_configuration
  @sort_configuration
end

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

The tooltip display setup of the visual.

Returns:

See Also:



2827
2828
2829
 
# File 'quick_sight/cfn_dashboard.rb', line 2827

def tooltip
  @tooltip
end

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

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

Returns:

See Also:



2832
2833
2834
 
# File 'quick_sight/cfn_dashboard.rb', line 2832

def visual_palette
  @visual_palette
end

Class Method Details

.jsii_properties ⇒ Object 



2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
 
# File 'quick_sight/cfn_dashboard.rb', line 2834

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 



2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
 
# File 'quick_sight/cfn_dashboard.rb', line 2851

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