Class: Aws::QuickSight::Types::HierarchyFilterListControl

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::HierarchyFilterListControl

Defined in:

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

Overview

A control from a hierarchy filter that displays the hierarchy as a list. You can expand a value to see and select the values beneath it, and select either a single value or multiple values.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #commit_mode ⇒ String

  The visibility configuration of the Apply button on a HierarchyFilterListControl.

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

  The display options of a control.

• #filter_control_id ⇒ String

  The ID of the HierarchyFilterListControl.

• #source_filter_id ⇒ String

  The source filter ID of the HierarchyFilterListControl.

• #title ⇒ String

  The title of the HierarchyFilterListControl.

• #type ⇒ String

  The type of the HierarchyFilterListControl.

Instance Attribute Details

#commit_mode ⇒ String

The visibility configuration of the Apply button on a HierarchyFilterListControl.

Returns:

• (String)

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

class HierarchyFilterListControl < Struct.new(
  :filter_control_id,
  :source_filter_id,
  :title,
  :display_options,
  :type,
  :commit_mode,
  :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 29150

class HierarchyFilterListControl < Struct.new(
  :filter_control_id,
  :source_filter_id,
  :title,
  :display_options,
  :type,
  :commit_mode,
  :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 29150

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

#display_options ⇒ Types::HierarchyFilterListControlDisplayOptions

The display options of a control.

Returns:

• (Types::HierarchyFilterListControlDisplayOptions)

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

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

#filter_control_id ⇒ String

The ID of the HierarchyFilterListControl.

Returns:

• (String)

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

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

#source_filter_id ⇒ String

The source filter ID of the HierarchyFilterListControl. This must be the FilterId of a HierarchyFilter.

Returns:

• (String)

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

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

#title ⇒ String

The title of the HierarchyFilterListControl.

Returns:

• (String)

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

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

#type ⇒ String

The type of the HierarchyFilterListControl. 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 29150

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