Class: AWSCDK::QuickSight::CfnDashboard::BarChartConfigurationProperty

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



1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
 
# File 'quick_sight/cfn_dashboard.rb', line 1869

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::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?
  @color_label_options = color_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ChartAxisLabelOptionsProperty.new(**color_label_options.transform_keys(&:to_sym)) : color_label_options
  Jsii::Type.check_type(@color_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5DaGFydEF4aXNMYWJlbE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "colorLabelOptions") unless @color_label_options.nil?
  @contribution_analysis_defaults = contribution_analysis_defaults
  Jsii::Type.check_type(@contribution_analysis_defaults, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuQ29udHJpYnV0aW9uQW5hbHlzaXNEZWZhdWx0UHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "contributionAnalysisDefaults") unless @contribution_analysis_defaults.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::BarChartFieldWellsProperty.new(**field_wells.transform_keys(&:to_sym)) : field_wells
  Jsii::Type.check_type(@field_wells, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5CYXJDaGFydEZpZWxkV2VsbHNQcm9wZXJ0eSJ9XX19")), "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?
  @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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuUmVmZXJlbmNlTGluZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "referenceLines") unless @reference_lines.nil?
  @small_multiples_options = small_multiples_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::SmallMultiplesOptionsProperty.new(**small_multiples_options.transform_keys(&:to_sym)) : small_multiples_options
  Jsii::Type.check_type(@small_multiples_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5TbWFsbE11bHRpcGxlc09wdGlvbnNQcm9wZXJ0eSJ9XX19")), "smallMultiplesOptions") unless @small_multiples_options.nil?
  @sort_configuration = sort_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::BarChartSortConfigurationProperty.new(**sort_configuration.transform_keys(&:to_sym)) : sort_configuration
  Jsii::Type.check_type(@sort_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5CYXJDaGFydFNvcnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "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?
  @value_axis = value_axis.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::AxisDisplayOptionsProperty.new(**value_axis.transform_keys(&:to_sym)) : value_axis
  Jsii::Type.check_type(@value_axis, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5BeGlzRGlzcGxheU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "valueAxis") unless @value_axis.nil?
  @value_label_options = value_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ChartAxisLabelOptionsProperty.new(**value_label_options.transform_keys(&:to_sym)) : value_label_options
  Jsii::Type.check_type(@value_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5DaGFydEF4aXNMYWJlbE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "valueLabelOptions") unless @value_label_options.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

#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:



1912
1913
1914
 
# File 'quick_sight/cfn_dashboard.rb', line 1912

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:



1917
1918
1919
 
# File 'quick_sight/cfn_dashboard.rb', line 1917

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:



1922
1923
1924
 
# File 'quick_sight/cfn_dashboard.rb', line 1922

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:



1927
1928
1929
 
# File 'quick_sight/cfn_dashboard.rb', line 1927

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:



1932
1933
1934
 
# File 'quick_sight/cfn_dashboard.rb', line 1932

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:



1937
1938
1939
 
# File 'quick_sight/cfn_dashboard.rb', line 1937

def data_labels
  @data_labels
end

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

The field wells of the visual.

Returns:

See Also:



1942
1943
1944
 
# File 'quick_sight/cfn_dashboard.rb', line 1942

def field_wells
  @field_wells
end

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

The general visual interactions setup for a visual.

Returns:

See Also:



1947
1948
1949
 
# File 'quick_sight/cfn_dashboard.rb', line 1947

def interactions
  @interactions
end

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

The legend display setup of the visual.

Returns:

See Also:



1952
1953
1954
 
# File 'quick_sight/cfn_dashboard.rb', line 1952

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:



1960
1961
1962
 
# File 'quick_sight/cfn_dashboard.rb', line 1960

def orientation
  @orientation
end

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

The reference line setup of the visual.

Returns:

See Also:



1965
1966
1967
 
# File 'quick_sight/cfn_dashboard.rb', line 1965

def reference_lines
  @reference_lines
end

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

The small multiples setup for the visual.

Returns:

See Also:



1970
1971
1972
 
# File 'quick_sight/cfn_dashboard.rb', line 1970

def small_multiples_options
  @small_multiples_options
end

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

The sort configuration of a BarChartVisual .

Returns:

See Also:



1975
1976
1977
 
# File 'quick_sight/cfn_dashboard.rb', line 1975

def sort_configuration
  @sort_configuration
end

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

The tooltip display setup of the visual.

Returns:

See Also:



1980
1981
1982
 
# File 'quick_sight/cfn_dashboard.rb', line 1980

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:



1985
1986
1987
 
# File 'quick_sight/cfn_dashboard.rb', line 1985

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:



1990
1991
1992
 
# File 'quick_sight/cfn_dashboard.rb', line 1990

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:



1995
1996
1997
 
# File 'quick_sight/cfn_dashboard.rb', line 1995

def visual_palette
  @visual_palette
end

Class Method Details

.jsii_properties ⇒ Object 



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
 
# File 'quick_sight/cfn_dashboard.rb', line 1997

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 



2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
 
# File 'quick_sight/cfn_dashboard.rb', line 2019

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