Class: Aws::QuickSight::Types::BarChartConfiguration

Inherits:

Struct

Object
Struct
Aws::QuickSight::Types::BarChartConfiguration

show all

Defined in:: gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

The configuration of a BarChartVisual.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#bars_arrangement ⇒ String
Determines the arrangement of the bars.
#category_axis ⇒ Types::AxisDisplayOptions
The label display options (grid line, range, scale, axis step) for bar chart category.
#category_label_options ⇒ Types::ChartAxisLabelOptions
The label options (label text, label visibility and sort icon visibility) for a bar chart.
#color_label_options ⇒ Types::ChartAxisLabelOptions
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
#contribution_analysis_defaults ⇒ Array<Types::ContributionAnalysisDefault>
The contribution analysis (anomaly configuration) setup of the visual.
#data_labels ⇒ Types::DataLabelOptions
The options that determine if visual data labels are displayed.
#default_series_settings ⇒ Types::BarChartDefaultSeriesSettings
The options that determine the default presentation of all bar series in BarChartVisual.
#field_wells ⇒ Types::BarChartFieldWells
The field wells of the visual.
#interactions ⇒ Types::VisualInteractionOptions
The general visual interactions setup for a visual.
#legend ⇒ Types::LegendOptions
The legend display setup of the visual.
#orientation ⇒ String
The orientation of the bars in a bar chart visual.
#reference_lines ⇒ Array<Types::ReferenceLine>
The reference line setup of the visual.
#series ⇒ Array<Types::BarSeriesItem>
The series item configuration of a BarChartVisual.
#small_multiples_options ⇒ Types::SmallMultiplesOptions
The small multiples setup for the visual.
#sort_configuration ⇒ Types::BarChartSortConfiguration
The sort configuration of a BarChartVisual.
#tooltip ⇒ Types::TooltipOptions
The tooltip display setup of the visual.
#value_axis ⇒ Types::AxisDisplayOptions
The label display options (grid line, range, scale, axis step) for a bar chart value.
#value_label_options ⇒ Types::ChartAxisLabelOptions
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
#visual_palette ⇒ Types::VisualPalette
The palette (chart color) display setup of the visual.

Instance Attribute Details

#bars_arrangement ⇒ `String`

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)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#category_axis ⇒ `Types::AxisDisplayOptions`

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

Returns:

(Types::AxisDisplayOptions)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#category_label_options ⇒ `Types::ChartAxisLabelOptions`

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

Returns:

(Types::ChartAxisLabelOptions)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#color_label_options ⇒ `Types::ChartAxisLabelOptions`

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

Returns:

(Types::ChartAxisLabelOptions)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#contribution_analysis_defaults ⇒ `Array<Types::ContributionAnalysisDefault>`

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

Returns:

(Array<Types::ContributionAnalysisDefault>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#data_labels ⇒ `Types::DataLabelOptions`

The options that determine if visual data labels are displayed.

Returns:

(Types::DataLabelOptions)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#default_series_settings ⇒ `Types::BarChartDefaultSeriesSettings`

The options that determine the default presentation of all bar series in BarChartVisual.

Returns:

(Types::BarChartDefaultSeriesSettings)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#field_wells ⇒ `Types::BarChartFieldWells`

The field wells of the visual.

Returns:

(Types::BarChartFieldWells)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#interactions ⇒ `Types::VisualInteractionOptions`

The general visual interactions setup for a visual.

Returns:

(Types::VisualInteractionOptions)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#legend ⇒ `Types::LegendOptions`

The legend display setup of the visual.

Returns:

(Types::LegendOptions)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#orientation ⇒ `String`

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)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#reference_lines ⇒ `Array<Types::ReferenceLine>`

The reference line setup of the visual.

Returns:

(Array<Types::ReferenceLine>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#series ⇒ `Array<Types::BarSeriesItem>`

The series item configuration of a BarChartVisual.

Returns:

(Array<Types::BarSeriesItem>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#small_multiples_options ⇒ `Types::SmallMultiplesOptions`

The small multiples setup for the visual.

Returns:

(Types::SmallMultiplesOptions)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#sort_configuration ⇒ `Types::BarChartSortConfiguration`

The sort configuration of a BarChartVisual.

Returns:

(Types::BarChartSortConfiguration)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

The tooltip display setup of the visual.

Returns:

(Types::TooltipOptions)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#value_axis ⇒ `Types::AxisDisplayOptions`

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

Returns:

(Types::AxisDisplayOptions)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#value_label_options ⇒ `Types::ChartAxisLabelOptions`

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

Returns:

(Types::ChartAxisLabelOptions)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

#visual_palette ⇒ `Types::VisualPalette`

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

Returns:

(Types::VisualPalette)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3379

class BarChartConfiguration < Struct.new(
  :field_wells,
  :sort_configuration,
  :orientation,
  :bars_arrangement,
  :visual_palette,
  :small_multiples_options,
  :category_axis,
  :category_label_options,
  :value_axis,
  :value_label_options,
  :color_label_options,
  :default_series_settings,
  :series,
  :legend,
  :data_labels,
  :tooltip,
  :reference_lines,
  :contribution_analysis_defaults,
  :interactions)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::QuickSight::Types::BarChartConfiguration

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#bars_arrangement ⇒ String

#category_axis ⇒ Types::AxisDisplayOptions

#category_label_options ⇒ Types::ChartAxisLabelOptions

#color_label_options ⇒ Types::ChartAxisLabelOptions

#contribution_analysis_defaults ⇒ Array<Types::ContributionAnalysisDefault>

#data_labels ⇒ Types::DataLabelOptions

#default_series_settings ⇒ Types::BarChartDefaultSeriesSettings

#field_wells ⇒ Types::BarChartFieldWells

#interactions ⇒ Types::VisualInteractionOptions

#legend ⇒ Types::LegendOptions

#orientation ⇒ String

#reference_lines ⇒ Array<Types::ReferenceLine>

#series ⇒ Array<Types::BarSeriesItem>

#small_multiples_options ⇒ Types::SmallMultiplesOptions

#sort_configuration ⇒ Types::BarChartSortConfiguration

#tooltip ⇒ Types::TooltipOptions

#value_axis ⇒ Types::AxisDisplayOptions

#value_label_options ⇒ Types::ChartAxisLabelOptions

#visual_palette ⇒ Types::VisualPalette

#bars_arrangement ⇒ `String`

#category_axis ⇒ `Types::AxisDisplayOptions`

#category_label_options ⇒ `Types::ChartAxisLabelOptions`

#color_label_options ⇒ `Types::ChartAxisLabelOptions`

#contribution_analysis_defaults ⇒ `Array<Types::ContributionAnalysisDefault>`

#data_labels ⇒ `Types::DataLabelOptions`

#default_series_settings ⇒ `Types::BarChartDefaultSeriesSettings`

#field_wells ⇒ `Types::BarChartFieldWells`

#interactions ⇒ `Types::VisualInteractionOptions`

#legend ⇒ `Types::LegendOptions`

#orientation ⇒ `String`

#reference_lines ⇒ `Array<Types::ReferenceLine>`

#series ⇒ `Array<Types::BarSeriesItem>`

#small_multiples_options ⇒ `Types::SmallMultiplesOptions`

#sort_configuration ⇒ `Types::BarChartSortConfiguration`

#tooltip ⇒ `Types::TooltipOptions`

#value_axis ⇒ `Types::AxisDisplayOptions`

#value_label_options ⇒ `Types::ChartAxisLabelOptions`

#visual_palette ⇒ `Types::VisualPalette`