Class: AWSCDK::QuickSight::CfnTemplate::FilterListControlProperty

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(filter_control_id:, source_filter_id:, title:, cascading_control_configuration: nil, display_options: nil, selectable_values: nil, type: nil) ⇒ FilterListControlProperty

Returns a new instance of FilterListControlProperty.

Parameters:



10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
 
# File 'quick_sight/cfn_template.rb', line 10047

def initialize(filter_control_id:, source_filter_id:, title:, cascading_control_configuration: nil, display_options: nil, selectable_values: nil, type: nil)
  @filter_control_id = filter_control_id
  Jsii::Type.check_type(@filter_control_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterControlId")
  @source_filter_id = source_filter_id
  Jsii::Type.check_type(@source_filter_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceFilterId")
  @title = title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "title")
  @cascading_control_configuration = cascading_control_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::CascadingControlConfigurationProperty.new(**cascading_control_configuration.transform_keys(&:to_sym)) : cascading_control_configuration
  Jsii::Type.check_type(@cascading_control_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNhc2NhZGluZ0NvbnRyb2xDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "cascadingControlConfiguration") unless @cascading_control_configuration.nil?
  @display_options = display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ListControlDisplayOptionsProperty.new(**display_options.transform_keys(&:to_sym)) : display_options
  Jsii::Type.check_type(@display_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkxpc3RDb250cm9sRGlzcGxheU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "displayOptions") unless @display_options.nil?
  @selectable_values = selectable_values.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FilterSelectableValuesProperty.new(**selectable_values.transform_keys(&:to_sym)) : selectable_values
  Jsii::Type.check_type(@selectable_values, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZpbHRlclNlbGVjdGFibGVWYWx1ZXNQcm9wZXJ0eSJ9XX19")), "selectableValues") unless @selectable_values.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

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

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:

See Also:



10083
10084
10085
 
# File 'quick_sight/cfn_template.rb', line 10083

def cascading_control_configuration
  @cascading_control_configuration
end

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

The display options of a control.

Returns:

See Also:



10088
10089
10090
 
# File 'quick_sight/cfn_template.rb', line 10088

def display_options
  @display_options
end

#filter_control_id ⇒ String (readonly)

The ID of the FilterListControl .

Returns:

  • (String)

See Also:



10068
10069
10070
 
# File 'quick_sight/cfn_template.rb', line 10068

def filter_control_id
  @filter_control_id
end

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

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

Returns:

See Also:



10093
10094
10095
 
# File 'quick_sight/cfn_template.rb', line 10093

def selectable_values
  @selectable_values
end

#source_filter_id ⇒ String (readonly)

The source filter ID of the FilterListControl .

Returns:

  • (String)

See Also:



10073
10074
10075
 
# File 'quick_sight/cfn_template.rb', line 10073

def source_filter_id
  @source_filter_id
end

#title ⇒ String (readonly)

The title of the FilterListControl .

Returns:

  • (String)

See Also:



10078
10079
10080
 
# File 'quick_sight/cfn_template.rb', line 10078

def title
  @title
end

#type ⇒ String? (readonly)

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, nil)

See Also:



10101
10102
10103
 
# File 'quick_sight/cfn_template.rb', line 10101

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
 
# File 'quick_sight/cfn_template.rb', line 10103

def self.jsii_properties
  {
    :filter_control_id => "filterControlId",
    :source_filter_id => "sourceFilterId",
    :title => "title",
    :cascading_control_configuration => "cascadingControlConfiguration",
    :display_options => "displayOptions",
    :selectable_values => "selectableValues",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
 
# File 'quick_sight/cfn_template.rb', line 10115

def to_jsii
  result = {}
  result.merge!({
    "filterControlId" => @filter_control_id,
    "sourceFilterId" => @source_filter_id,
    "title" => @title,
    "cascadingControlConfiguration" => @cascading_control_configuration,
    "displayOptions" => @display_options,
    "selectableValues" => @selectable_values,
    "type" => @type,
  })
  result.compact
end