Class: AWSCDK::QuickSight::CfnDashboard::WaterfallChartConfigurationProperty

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

Overview

The configuration for a waterfall visual.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(category_axis_display_options: nil, category_axis_label_options: nil, color_configuration: nil, data_labels: nil, field_wells: nil, interactions: nil, legend: nil, primary_y_axis_display_options: nil, primary_y_axis_label_options: nil, sort_configuration: nil, visual_palette: nil, waterfall_chart_options: nil) ⇒ WaterfallChartConfigurationProperty

Returns a new instance of WaterfallChartConfigurationProperty.

Parameters:



32769
32770
32771
32772
32773
32774
32775
32776
32777
32778
32779
32780
32781
32782
32783
32784
32785
32786
32787
32788
32789
32790
32791
32792
32793
32794
 
# File 'quick_sight/cfn_dashboard.rb', line 32769

def initialize(category_axis_display_options: nil, category_axis_label_options: nil, color_configuration: nil, data_labels: nil, field_wells: nil, interactions: nil, legend: nil, primary_y_axis_display_options: nil, primary_y_axis_label_options: nil, sort_configuration: nil, visual_palette: nil, waterfall_chart_options: nil)
  @category_axis_display_options = category_axis_display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::AxisDisplayOptionsProperty.new(**category_axis_display_options.transform_keys(&:to_sym)) : category_axis_display_options
  Jsii::Type.check_type(@category_axis_display_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5BeGlzRGlzcGxheU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "categoryAxisDisplayOptions") unless @category_axis_display_options.nil?
  @category_axis_label_options = category_axis_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ChartAxisLabelOptionsProperty.new(**category_axis_label_options.transform_keys(&:to_sym)) : category_axis_label_options
  Jsii::Type.check_type(@category_axis_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5DaGFydEF4aXNMYWJlbE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "categoryAxisLabelOptions") unless @category_axis_label_options.nil?
  @color_configuration = color_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::WaterfallChartColorConfigurationProperty.new(**color_configuration.transform_keys(&:to_sym)) : color_configuration
  Jsii::Type.check_type(@color_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5XYXRlcmZhbGxDaGFydENvbG9yQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "colorConfiguration") unless @color_configuration.nil?
  @data_labels = data_labels.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::DataLabelOptionsProperty.new(**data_labels.transform_keys(&:to_sym)) : data_labels
  Jsii::Type.check_type(@data_labels, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EYXRhTGFiZWxPcHRpb25zUHJvcGVydHkifV19fQ==")), "dataLabels") unless @data_labels.nil?
  @field_wells = field_wells.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::WaterfallChartFieldWellsProperty.new(**field_wells.transform_keys(&:to_sym)) : field_wells
  Jsii::Type.check_type(@field_wells, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5XYXRlcmZhbGxDaGFydEZpZWxkV2VsbHNQcm9wZXJ0eSJ9XX19")), "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?
  @sort_configuration = sort_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::WaterfallChartSortConfigurationProperty.new(**sort_configuration.transform_keys(&:to_sym)) : sort_configuration
  Jsii::Type.check_type(@sort_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5XYXRlcmZhbGxDaGFydFNvcnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "sortConfiguration") unless @sort_configuration.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?
  @waterfall_chart_options = waterfall_chart_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::WaterfallChartOptionsProperty.new(**waterfall_chart_options.transform_keys(&:to_sym)) : waterfall_chart_options
  Jsii::Type.check_type(@waterfall_chart_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5XYXRlcmZhbGxDaGFydE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "waterfallChartOptions") unless @waterfall_chart_options.nil?
end

Instance Attribute Details

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

The options that determine the presentation of the category axis.

Returns:

See Also:



32800
32801
32802
 
# File 'quick_sight/cfn_dashboard.rb', line 32800

def category_axis_display_options
  @category_axis_display_options
end

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

The options that determine the presentation of the category axis label.

Returns:

See Also:



32805
32806
32807
 
# File 'quick_sight/cfn_dashboard.rb', line 32805

def category_axis_label_options
  @category_axis_label_options
end

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

The color configuration of a waterfall visual.

Returns:

See Also:



32810
32811
32812
 
# File 'quick_sight/cfn_dashboard.rb', line 32810

def color_configuration
  @color_configuration
end

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

The data label configuration of a waterfall visual.

Returns:

See Also:



32815
32816
32817
 
# File 'quick_sight/cfn_dashboard.rb', line 32815

def data_labels
  @data_labels
end

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

The field well configuration of a waterfall visual.

Returns:

See Also:



32820
32821
32822
 
# File 'quick_sight/cfn_dashboard.rb', line 32820

def field_wells
  @field_wells
end

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

The general visual interactions setup for a visual.

Returns:

See Also:



32825
32826
32827
 
# File 'quick_sight/cfn_dashboard.rb', line 32825

def interactions
  @interactions
end

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

The legend configuration of a waterfall visual.

Returns:

See Also:



32830
32831
32832
 
# File 'quick_sight/cfn_dashboard.rb', line 32830

def legend
  @legend
end

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

The options that determine the presentation of the y-axis.

Returns:

See Also:



32835
32836
32837
 
# File 'quick_sight/cfn_dashboard.rb', line 32835

def primary_y_axis_display_options
  @primary_y_axis_display_options
end

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

The options that determine the presentation of the y-axis label.

Returns:

See Also:



32840
32841
32842
 
# File 'quick_sight/cfn_dashboard.rb', line 32840

def primary_y_axis_label_options
  @primary_y_axis_label_options
end

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

The sort configuration of a waterfall visual.

Returns:

See Also:



32845
32846
32847
 
# File 'quick_sight/cfn_dashboard.rb', line 32845

def sort_configuration
  @sort_configuration
end

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

The visual palette configuration of a waterfall visual.

Returns:

See Also:



32850
32851
32852
 
# File 'quick_sight/cfn_dashboard.rb', line 32850

def visual_palette
  @visual_palette
end

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

The options that determine the presentation of a waterfall visual.

Returns:

See Also:



32855
32856
32857
 
# File 'quick_sight/cfn_dashboard.rb', line 32855

def waterfall_chart_options
  @waterfall_chart_options
end

Class Method Details

.jsii_properties ⇒ Object 



32857
32858
32859
32860
32861
32862
32863
32864
32865
32866
32867
32868
32869
32870
32871
32872
 
# File 'quick_sight/cfn_dashboard.rb', line 32857

def self.jsii_properties
  {
    :category_axis_display_options => "categoryAxisDisplayOptions",
    :category_axis_label_options => "categoryAxisLabelOptions",
    :color_configuration => "colorConfiguration",
    :data_labels => "dataLabels",
    :field_wells => "fieldWells",
    :interactions => "interactions",
    :legend => "legend",
    :primary_y_axis_display_options => "primaryYAxisDisplayOptions",
    :primary_y_axis_label_options => "primaryYAxisLabelOptions",
    :sort_configuration => "sortConfiguration",
    :visual_palette => "visualPalette",
    :waterfall_chart_options => "waterfallChartOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



32874
32875
32876
32877
32878
32879
32880
32881
32882
32883
32884
32885
32886
32887
32888
32889
32890
32891
 
# File 'quick_sight/cfn_dashboard.rb', line 32874

def to_jsii
  result = {}
  result.merge!({
    "categoryAxisDisplayOptions" => @category_axis_display_options,
    "categoryAxisLabelOptions" => @category_axis_label_options,
    "colorConfiguration" => @color_configuration,
    "dataLabels" => @data_labels,
    "fieldWells" => @field_wells,
    "interactions" => @interactions,
    "legend" => @legend,
    "primaryYAxisDisplayOptions" => @primary_y_axis_display_options,
    "primaryYAxisLabelOptions" => @primary_y_axis_label_options,
    "sortConfiguration" => @sort_configuration,
    "visualPalette" => @visual_palette,
    "waterfallChartOptions" => @waterfall_chart_options,
  })
  result.compact
end