Class: AWSCDK::QuickSight::CfnAnalysis::BarChartConfigurationProperty

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

Overview

The configuration of a BarChartVisual .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bars_arrangement: nil, category_axis: nil, category_label_options: nil, color_label_options: nil, contribution_analysis_defaults: nil, data_labels: nil, field_wells: nil, interactions: nil, legend: nil, orientation: nil, reference_lines: nil, small_multiples_options: nil, sort_configuration: nil, tooltip: nil, value_axis: nil, value_label_options: nil, visual_palette: nil) ⇒ BarChartConfigurationProperty

Returns a new instance of BarChartConfigurationProperty.

Parameters:



2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
 
# File 'quick_sight/cfn_analysis.rb', line 2003

def initialize(bars_arrangement: nil, category_axis: nil, category_label_options: nil, color_label_options: nil, contribution_analysis_defaults: nil, data_labels: nil, field_wells: nil, interactions: nil, legend: nil, orientation: nil, reference_lines: nil, small_multiples_options: nil, sort_configuration: nil, tooltip: nil, value_axis: nil, value_label_options: nil, visual_palette: 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::CfnAnalysis::AxisDisplayOptionsProperty.new(**category_axis.transform_keys(&:to_sym)) : category_axis
  Jsii::Type.check_type(@category_axis, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkF4aXNEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "categoryAxis") unless @category_axis.nil?
  @category_label_options = category_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ChartAxisLabelOptionsProperty.new(**category_label_options.transform_keys(&:to_sym)) : category_label_options
  Jsii::Type.check_type(@category_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "categoryLabelOptions") unless @category_label_options.nil?
  @color_label_options = color_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ChartAxisLabelOptionsProperty.new(**color_label_options.transform_keys(&:to_sym)) : color_label_options
  Jsii::Type.check_type(@color_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "colorLabelOptions") unless @color_label_options.nil?
  @contribution_analysis_defaults = contribution_analysis_defaults
  Jsii::Type.check_type(@contribution_analysis_defaults, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5Db250cmlidXRpb25BbmFseXNpc0RlZmF1bHRQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "contributionAnalysisDefaults") unless @contribution_analysis_defaults.nil?
  @data_labels = data_labels.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::DataLabelOptionsProperty.new(**data_labels.transform_keys(&:to_sym)) : data_labels
  Jsii::Type.check_type(@data_labels, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkRhdGFMYWJlbE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "dataLabels") unless @data_labels.nil?
  @field_wells = field_wells.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::BarChartFieldWellsProperty.new(**field_wells.transform_keys(&:to_sym)) : field_wells
  Jsii::Type.check_type(@field_wells, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkJhckNoYXJ0RmllbGRXZWxsc1Byb3BlcnR5In1dfX0=")), "fieldWells") unless @field_wells.nil?
  @interactions = interactions.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::VisualInteractionOptionsProperty.new(**interactions.transform_keys(&:to_sym)) : interactions
  Jsii::Type.check_type(@interactions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlZpc3VhbEludGVyYWN0aW9uT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "interactions") unless @interactions.nil?
  @legend = legend.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::LegendOptionsProperty.new(**legend.transform_keys(&:to_sym)) : legend
  Jsii::Type.check_type(@legend, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkxlZ2VuZE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "legend") unless @legend.nil?
  @orientation = orientation
  Jsii::Type.check_type(@orientation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "orientation") unless @orientation.nil?
  @reference_lines = reference_lines
  Jsii::Type.check_type(@reference_lines, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5SZWZlcmVuY2VMaW5lUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "referenceLines") unless @reference_lines.nil?
  @small_multiples_options = small_multiples_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::SmallMultiplesOptionsProperty.new(**small_multiples_options.transform_keys(&:to_sym)) : small_multiples_options
  Jsii::Type.check_type(@small_multiples_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlNtYWxsTXVsdGlwbGVzT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "smallMultiplesOptions") unless @small_multiples_options.nil?
  @sort_configuration = sort_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::BarChartSortConfigurationProperty.new(**sort_configuration.transform_keys(&:to_sym)) : sort_configuration
  Jsii::Type.check_type(@sort_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkJhckNoYXJ0U29ydENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "sortConfiguration") unless @sort_configuration.nil?
  @tooltip = tooltip.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::TooltipOptionsProperty.new(**tooltip.transform_keys(&:to_sym)) : tooltip
  Jsii::Type.check_type(@tooltip, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlRvb2x0aXBPcHRpb25zUHJvcGVydHkifV19fQ==")), "tooltip") unless @tooltip.nil?
  @value_axis = value_axis.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::AxisDisplayOptionsProperty.new(**value_axis.transform_keys(&:to_sym)) : value_axis
  Jsii::Type.check_type(@value_axis, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkF4aXNEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "valueAxis") unless @value_axis.nil?
  @value_label_options = value_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ChartAxisLabelOptionsProperty.new(**value_label_options.transform_keys(&:to_sym)) : value_label_options
  Jsii::Type.check_type(@value_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "valueLabelOptions") unless @value_label_options.nil?
  @visual_palette = visual_palette.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::VisualPaletteProperty.new(**visual_palette.transform_keys(&:to_sym)) : visual_palette
  Jsii::Type.check_type(@visual_palette, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlZpc3VhbFBhbGV0dGVQcm9wZXJ0eSJ9XX19")), "visualPalette") unless @visual_palette.nil?
end

Instance Attribute Details

#bars_arrangement ⇒ String? (readonly)

Determines the arrangement of the bars.

The orientation and arrangement of bars determine the type of bar that is used in the visual.

Returns:

  • (String, nil)

See Also:



2046
2047
2048
 
# File 'quick_sight/cfn_analysis.rb', line 2046

def bars_arrangement
  @bars_arrangement
end

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

The label display options (grid line, range, scale, axis step) for bar chart category.

Returns:

See Also:



2051
2052
2053
 
# File 'quick_sight/cfn_analysis.rb', line 2051

def category_axis
  @category_axis
end

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

The label options (label text, label visibility and sort icon visibility) for a bar chart.

Returns:

See Also:



2056
2057
2058
 
# File 'quick_sight/cfn_analysis.rb', line 2056

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) for a color that is used in a bar chart.

Returns:

See Also:



2061
2062
2063
 
# File 'quick_sight/cfn_analysis.rb', line 2061

def color_label_options
  @color_label_options
end

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

The contribution analysis (anomaly configuration) setup of the visual.

Returns:

See Also:



2066
2067
2068
 
# File 'quick_sight/cfn_analysis.rb', line 2066

def contribution_analysis_defaults
  @contribution_analysis_defaults
end

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

The options that determine if visual data labels are displayed.

Returns:

See Also:



2071
2072
2073
 
# File 'quick_sight/cfn_analysis.rb', line 2071

def data_labels
  @data_labels
end

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

The field wells of the visual.

Returns:

See Also:



2076
2077
2078
 
# File 'quick_sight/cfn_analysis.rb', line 2076

def field_wells
  @field_wells
end

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

The general visual interactions setup for a visual.

Returns:

See Also:



2081
2082
2083
 
# File 'quick_sight/cfn_analysis.rb', line 2081

def interactions
  @interactions
end

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

The legend display setup of the visual.

Returns:

See Also:



2086
2087
2088
 
# File 'quick_sight/cfn_analysis.rb', line 2086

def legend
  @legend
end

#orientation ⇒ String? (readonly)

The orientation of the bars in a bar chart visual. There are two valid values in this structure:.

  • HORIZONTAL : Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.
  • VERTICAL : Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.

Returns:

  • (String, nil)

See Also:



2094
2095
2096
 
# File 'quick_sight/cfn_analysis.rb', line 2094

def orientation
  @orientation
end

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

The reference line setup of the visual.

Returns:

See Also:



2099
2100
2101
 
# File 'quick_sight/cfn_analysis.rb', line 2099

def reference_lines
  @reference_lines
end

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

The small multiples setup for the visual.

Returns:

See Also:



2104
2105
2106
 
# File 'quick_sight/cfn_analysis.rb', line 2104

def small_multiples_options
  @small_multiples_options
end

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

The sort configuration of a BarChartVisual .

Returns:

See Also:



2109
2110
2111
 
# File 'quick_sight/cfn_analysis.rb', line 2109

def sort_configuration
  @sort_configuration
end

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

The tooltip display setup of the visual.

Returns:

See Also:



2114
2115
2116
 
# File 'quick_sight/cfn_analysis.rb', line 2114

def tooltip
  @tooltip
end

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

The label display options (grid line, range, scale, axis step) for a bar chart value.

Returns:

See Also:



2119
2120
2121
 
# File 'quick_sight/cfn_analysis.rb', line 2119

def value_axis
  @value_axis
end

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

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

Returns:

See Also:



2124
2125
2126
 
# File 'quick_sight/cfn_analysis.rb', line 2124

def value_label_options
  @value_label_options
end

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

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

Returns:

See Also:



2129
2130
2131
 
# File 'quick_sight/cfn_analysis.rb', line 2129

def visual_palette
  @visual_palette
end

Class Method Details

.jsii_properties ⇒ Object 



2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
 
# File 'quick_sight/cfn_analysis.rb', line 2131

def self.jsii_properties
  {
    :bars_arrangement => "barsArrangement",
    :category_axis => "categoryAxis",
    :category_label_options => "categoryLabelOptions",
    :color_label_options => "colorLabelOptions",
    :contribution_analysis_defaults => "contributionAnalysisDefaults",
    :data_labels => "dataLabels",
    :field_wells => "fieldWells",
    :interactions => "interactions",
    :legend => "legend",
    :orientation => "orientation",
    :reference_lines => "referenceLines",
    :small_multiples_options => "smallMultiplesOptions",
    :sort_configuration => "sortConfiguration",
    :tooltip => "tooltip",
    :value_axis => "valueAxis",
    :value_label_options => "valueLabelOptions",
    :visual_palette => "visualPalette",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
 
# File 'quick_sight/cfn_analysis.rb', line 2153

def to_jsii
  result = {}
  result.merge!({
    "barsArrangement" => @bars_arrangement,
    "categoryAxis" => @category_axis,
    "categoryLabelOptions" => @category_label_options,
    "colorLabelOptions" => @color_label_options,
    "contributionAnalysisDefaults" => @contribution_analysis_defaults,
    "dataLabels" => @data_labels,
    "fieldWells" => @field_wells,
    "interactions" => @interactions,
    "legend" => @legend,
    "orientation" => @orientation,
    "referenceLines" => @reference_lines,
    "smallMultiplesOptions" => @small_multiples_options,
    "sortConfiguration" => @sort_configuration,
    "tooltip" => @tooltip,
    "valueAxis" => @value_axis,
    "valueLabelOptions" => @value_label_options,
    "visualPalette" => @visual_palette,
  })
  result.compact
end