Class: Aws::QuickSight::Types::FilterListControl

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::FilterListControl

Defined in:

gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cascading_control_configuration ⇒ Types::CascadingControlConfiguration

  The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

• #control_sort_configurations ⇒ Array<Types::ControlSortConfiguration>

  The sort configuration for the values displayed in the control.

• #control_title_format_text ⇒ Types::ControlTitleFormatText

  The title text format configuration for the control.

• #display_options ⇒ Types::ListControlDisplayOptions

  The display options of a control.

• #filter_control_id ⇒ String

  The ID of the FilterListControl.

• #selectable_values ⇒ Types::FilterSelectableValues

  A list of selectable values that are used in a control.

• #source_filter_id ⇒ String

  The source filter ID of the FilterListControl.

• #title ⇒ String

  The title of the FilterListControl.

• #type ⇒ String

  The type of the FilterListControl.

Instance Attribute Details

#cascading_control_configuration ⇒ Types::CascadingControlConfiguration

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

Returns:

• (Types::CascadingControlConfiguration)

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

class FilterListControl < Struct.new(
  :filter_control_id,
  :title,
  :source_filter_id,
  :display_options,
  :type,
  :selectable_values,
  :cascading_control_configuration,
  :control_sort_configurations,
  :control_title_format_text)
  SENSITIVE = []
  include Aws::Structure
end

#control_sort_configurations ⇒ Array<Types::ControlSortConfiguration>

The sort configuration for the values displayed in the control. Only one sort configuration can be applied per control.

Returns:

• (Array<Types::ControlSortConfiguration>)

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

class FilterListControl < Struct.new(
  :filter_control_id,
  :title,
  :source_filter_id,
  :display_options,
  :type,
  :selectable_values,
  :cascading_control_configuration,
  :control_sort_configurations,
  :control_title_format_text)
  SENSITIVE = []
  include Aws::Structure
end

#control_title_format_text ⇒ Types::ControlTitleFormatText

The title text format configuration for the control.

Returns:

• (Types::ControlTitleFormatText)

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

class FilterListControl < Struct.new(
  :filter_control_id,
  :title,
  :source_filter_id,
  :display_options,
  :type,
  :selectable_values,
  :cascading_control_configuration,
  :control_sort_configurations,
  :control_title_format_text)
  SENSITIVE = []
  include Aws::Structure
end

#display_options ⇒ Types::ListControlDisplayOptions

The display options of a control.

Returns:

• (Types::ListControlDisplayOptions)

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

class FilterListControl < Struct.new(
  :filter_control_id,
  :title,
  :source_filter_id,
  :display_options,
  :type,
  :selectable_values,
  :cascading_control_configuration,
  :control_sort_configurations,
  :control_title_format_text)
  SENSITIVE = []
  include Aws::Structure
end

#filter_control_id ⇒ String

The ID of the FilterListControl.

Returns:

• (String)

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

class FilterListControl < Struct.new(
  :filter_control_id,
  :title,
  :source_filter_id,
  :display_options,
  :type,
  :selectable_values,
  :cascading_control_configuration,
  :control_sort_configurations,
  :control_title_format_text)
  SENSITIVE = []
  include Aws::Structure
end

#selectable_values ⇒ Types::FilterSelectableValues

A list of selectable values that are used in a control.

Returns:

• (Types::FilterSelectableValues)

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

class FilterListControl < Struct.new(
  :filter_control_id,
  :title,
  :source_filter_id,
  :display_options,
  :type,
  :selectable_values,
  :cascading_control_configuration,
  :control_sort_configurations,
  :control_title_format_text)
  SENSITIVE = []
  include Aws::Structure
end

#source_filter_id ⇒ String

The source filter ID of the FilterListControl.

Returns:

• (String)

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

class FilterListControl < Struct.new(
  :filter_control_id,
  :title,
  :source_filter_id,
  :display_options,
  :type,
  :selectable_values,
  :cascading_control_configuration,
  :control_sort_configurations,
  :control_title_format_text)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of the FilterListControl.

Returns:

• (String)

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

class FilterListControl < Struct.new(
  :filter_control_id,
  :title,
  :source_filter_id,
  :display_options,
  :type,
  :selectable_values,
  :cascading_control_configuration,
  :control_sort_configurations,
  :control_title_format_text)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the FilterListControl. Choose one of the following options:

• MULTI_SELECT: The user can select multiple entries from the list.

• SINGLE_SELECT: The user can select a single entry from the list.

Returns:

• (String)

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

class FilterListControl < Struct.new(
  :filter_control_id,
  :title,
  :source_filter_id,
  :display_options,
  :type,
  :selectable_values,
  :cascading_control_configuration,
  :control_sort_configurations,
  :control_title_format_text)
  SENSITIVE = []
  include Aws::Structure
end