Class: AWSCDK::QuickSight::CfnTemplate::WaterfallChartConfigurationProperty

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



29970
29971
29972
29973
29974
29975
29976
29977
29978
29979
29980
29981
29982
29983
29984
29985
29986
29987
29988
29989
29990
29991
29992
29993
29994
29995
 
# File 'quick_sight/cfn_template.rb', line 29970

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::CfnTemplate::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkF4aXNEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "categoryAxisDisplayOptions") unless @category_axis_display_options.nil?
  @category_axis_label_options = category_axis_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "categoryAxisLabelOptions") unless @category_axis_label_options.nil?
  @color_configuration = color_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::WaterfallChartColorConfigurationProperty.new(**color_configuration.transform_keys(&:to_sym)) : color_configuration
  Jsii::Type.check_type(@color_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLldhdGVyZmFsbENoYXJ0Q29sb3JDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "colorConfiguration") unless @color_configuration.nil?
  @data_labels = data_labels.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::DataLabelOptionsProperty.new(**data_labels.transform_keys(&:to_sym)) : data_labels
  Jsii::Type.check_type(@data_labels, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkRhdGFMYWJlbE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "dataLabels") unless @data_labels.nil?
  @field_wells = field_wells.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::WaterfallChartFieldWellsProperty.new(**field_wells.transform_keys(&:to_sym)) : field_wells
  Jsii::Type.check_type(@field_wells, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLldhdGVyZmFsbENoYXJ0RmllbGRXZWxsc1Byb3BlcnR5In1dfX0=")), "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?
  @sort_configuration = sort_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::WaterfallChartSortConfigurationProperty.new(**sort_configuration.transform_keys(&:to_sym)) : sort_configuration
  Jsii::Type.check_type(@sort_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLldhdGVyZmFsbENoYXJ0U29ydENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "sortConfiguration") unless @sort_configuration.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?
  @waterfall_chart_options = waterfall_chart_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::WaterfallChartOptionsProperty.new(**waterfall_chart_options.transform_keys(&:to_sym)) : waterfall_chart_options
  Jsii::Type.check_type(@waterfall_chart_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLldhdGVyZmFsbENoYXJ0T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "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:



30001
30002
30003
 
# File 'quick_sight/cfn_template.rb', line 30001

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:



30006
30007
30008
 
# File 'quick_sight/cfn_template.rb', line 30006

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:



30011
30012
30013
 
# File 'quick_sight/cfn_template.rb', line 30011

def color_configuration
  @color_configuration
end

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

The data label configuration of a waterfall visual.

Returns:

See Also:



30016
30017
30018
 
# File 'quick_sight/cfn_template.rb', line 30016

def data_labels
  @data_labels
end

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

The field well configuration of a waterfall visual.

Returns:

See Also:



30021
30022
30023
 
# File 'quick_sight/cfn_template.rb', line 30021

def field_wells
  @field_wells
end

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

The general visual interactions setup for a visual.

Returns:

See Also:



30026
30027
30028
 
# File 'quick_sight/cfn_template.rb', line 30026

def interactions
  @interactions
end

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

The legend configuration of a waterfall visual.

Returns:

See Also:



30031
30032
30033
 
# File 'quick_sight/cfn_template.rb', line 30031

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:



30036
30037
30038
 
# File 'quick_sight/cfn_template.rb', line 30036

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:



30041
30042
30043
 
# File 'quick_sight/cfn_template.rb', line 30041

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:



30046
30047
30048
 
# File 'quick_sight/cfn_template.rb', line 30046

def sort_configuration
  @sort_configuration
end

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

The visual palette configuration of a waterfall visual.

Returns:

See Also:



30051
30052
30053
 
# File 'quick_sight/cfn_template.rb', line 30051

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:



30056
30057
30058
 
# File 'quick_sight/cfn_template.rb', line 30056

def waterfall_chart_options
  @waterfall_chart_options
end

Class Method Details

.jsii_properties ⇒ Object 



30058
30059
30060
30061
30062
30063
30064
30065
30066
30067
30068
30069
30070
30071
30072
30073
 
# File 'quick_sight/cfn_template.rb', line 30058

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 



30075
30076
30077
30078
30079
30080
30081
30082
30083
30084
30085
30086
30087
30088
30089
30090
30091
30092
 
# File 'quick_sight/cfn_template.rb', line 30075

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