Class: AWSCDK::QuickSight::CfnTemplate::BarChartConfigurationProperty

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



1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
 
# File 'quick_sight/cfn_template.rb', line 1725

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::CfnTemplate::AxisDisplayOptionsProperty.new(**category_axis.transform_keys(&:to_sym)) : category_axis
  Jsii::Type.check_type(@category_axis, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkF4aXNEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "categoryAxis") unless @category_axis.nil?
  @category_label_options = category_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ChartAxisLabelOptionsProperty.new(**category_label_options.transform_keys(&:to_sym)) : category_label_options
  Jsii::Type.check_type(@category_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "categoryLabelOptions") unless @category_label_options.nil?
  @color_label_options = color_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ChartAxisLabelOptionsProperty.new(**color_label_options.transform_keys(&:to_sym)) : color_label_options
  Jsii::Type.check_type(@color_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "colorLabelOptions") unless @color_label_options.nil?
  @contribution_analysis_defaults = contribution_analysis_defaults
  Jsii::Type.check_type(@contribution_analysis_defaults, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5Db250cmlidXRpb25BbmFseXNpc0RlZmF1bHRQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "contributionAnalysisDefaults") unless @contribution_analysis_defaults.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::BarChartFieldWellsProperty.new(**field_wells.transform_keys(&:to_sym)) : field_wells
  Jsii::Type.check_type(@field_wells, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkJhckNoYXJ0RmllbGRXZWxsc1Byb3BlcnR5In1dfX0=")), "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?
  @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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5SZWZlcmVuY2VMaW5lUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "referenceLines") unless @reference_lines.nil?
  @small_multiples_options = small_multiples_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::SmallMultiplesOptionsProperty.new(**small_multiples_options.transform_keys(&:to_sym)) : small_multiples_options
  Jsii::Type.check_type(@small_multiples_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlNtYWxsTXVsdGlwbGVzT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "smallMultiplesOptions") unless @small_multiples_options.nil?
  @sort_configuration = sort_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::BarChartSortConfigurationProperty.new(**sort_configuration.transform_keys(&:to_sym)) : sort_configuration
  Jsii::Type.check_type(@sort_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkJhckNoYXJ0U29ydENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "sortConfiguration") unless @sort_configuration.nil?
  @tooltip = tooltip.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::TooltipOptionsProperty.new(**tooltip.transform_keys(&:to_sym)) : tooltip
  Jsii::Type.check_type(@tooltip, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRvb2x0aXBPcHRpb25zUHJvcGVydHkifV19fQ==")), "tooltip") unless @tooltip.nil?
  @value_axis = value_axis.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::AxisDisplayOptionsProperty.new(**value_axis.transform_keys(&:to_sym)) : value_axis
  Jsii::Type.check_type(@value_axis, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkF4aXNEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "valueAxis") unless @value_axis.nil?
  @value_label_options = value_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ChartAxisLabelOptionsProperty.new(**value_label_options.transform_keys(&:to_sym)) : value_label_options
  Jsii::Type.check_type(@value_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "valueLabelOptions") unless @value_label_options.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?
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:



1768
1769
1770
 
# File 'quick_sight/cfn_template.rb', line 1768

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:



1773
1774
1775
 
# File 'quick_sight/cfn_template.rb', line 1773

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:



1778
1779
1780
 
# File 'quick_sight/cfn_template.rb', line 1778

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:



1783
1784
1785
 
# File 'quick_sight/cfn_template.rb', line 1783

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:



1788
1789
1790
 
# File 'quick_sight/cfn_template.rb', line 1788

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:



1793
1794
1795
 
# File 'quick_sight/cfn_template.rb', line 1793

def data_labels
  @data_labels
end

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

The field wells of the visual.

Returns:

See Also:



1798
1799
1800
 
# File 'quick_sight/cfn_template.rb', line 1798

def field_wells
  @field_wells
end

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

The general visual interactions setup for a visual.

Returns:

See Also:



1803
1804
1805
 
# File 'quick_sight/cfn_template.rb', line 1803

def interactions
  @interactions
end

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

The legend display setup of the visual.

Returns:

See Also:



1808
1809
1810
 
# File 'quick_sight/cfn_template.rb', line 1808

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:



1816
1817
1818
 
# File 'quick_sight/cfn_template.rb', line 1816

def orientation
  @orientation
end

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

The reference line setup of the visual.

Returns:

See Also:



1821
1822
1823
 
# File 'quick_sight/cfn_template.rb', line 1821

def reference_lines
  @reference_lines
end

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

The small multiples setup for the visual.

Returns:

See Also:



1826
1827
1828
 
# File 'quick_sight/cfn_template.rb', line 1826

def small_multiples_options
  @small_multiples_options
end

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

The sort configuration of a BarChartVisual .

Returns:

See Also:



1831
1832
1833
 
# File 'quick_sight/cfn_template.rb', line 1831

def sort_configuration
  @sort_configuration
end

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

The tooltip display setup of the visual.

Returns:

See Also:



1836
1837
1838
 
# File 'quick_sight/cfn_template.rb', line 1836

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:



1841
1842
1843
 
# File 'quick_sight/cfn_template.rb', line 1841

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:



1846
1847
1848
 
# File 'quick_sight/cfn_template.rb', line 1846

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:



1851
1852
1853
 
# File 'quick_sight/cfn_template.rb', line 1851

def visual_palette
  @visual_palette
end

Class Method Details

.jsii_properties ⇒ Object 



1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
 
# File 'quick_sight/cfn_template.rb', line 1853

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 



1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
 
# File 'quick_sight/cfn_template.rb', line 1875

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