Class: AWSCDK::QuickSight::CfnAnalysis::FilterListControlProperty

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



10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
 
# File 'quick_sight/cfn_analysis.rb', line 10239

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::CfnAnalysis::CascadingControlConfigurationProperty.new(**cascading_control_configuration.transform_keys(&:to_sym)) : cascading_control_configuration
  Jsii::Type.check_type(@cascading_control_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkNhc2NhZGluZ0NvbnRyb2xDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "cascadingControlConfiguration") unless @cascading_control_configuration.nil?
  @display_options = display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ListControlDisplayOptionsProperty.new(**display_options.transform_keys(&:to_sym)) : display_options
  Jsii::Type.check_type(@display_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkxpc3RDb250cm9sRGlzcGxheU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "displayOptions") unless @display_options.nil?
  @selectable_values = selectable_values.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::FilterSelectableValuesProperty.new(**selectable_values.transform_keys(&:to_sym)) : selectable_values
  Jsii::Type.check_type(@selectable_values, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkZpbHRlclNlbGVjdGFibGVWYWx1ZXNQcm9wZXJ0eSJ9XX19")), "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:



10275
10276
10277
 
# File 'quick_sight/cfn_analysis.rb', line 10275

def cascading_control_configuration
  @cascading_control_configuration
end

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

The display options of a control.

Returns:

See Also:



10280
10281
10282
 
# File 'quick_sight/cfn_analysis.rb', line 10280

def display_options
  @display_options
end

#filter_control_id ⇒ String (readonly)

The ID of the FilterListControl .

Returns:

  • (String)

See Also:



10260
10261
10262
 
# File 'quick_sight/cfn_analysis.rb', line 10260

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:



10285
10286
10287
 
# File 'quick_sight/cfn_analysis.rb', line 10285

def selectable_values
  @selectable_values
end

#source_filter_id ⇒ String (readonly)

The source filter ID of the FilterListControl .

Returns:

  • (String)

See Also:



10265
10266
10267
 
# File 'quick_sight/cfn_analysis.rb', line 10265

def source_filter_id
  @source_filter_id
end

#title ⇒ String (readonly)

The title of the FilterListControl .

Returns:

  • (String)

See Also:



10270
10271
10272
 
# File 'quick_sight/cfn_analysis.rb', line 10270

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:



10293
10294
10295
 
# File 'quick_sight/cfn_analysis.rb', line 10293

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
 
# File 'quick_sight/cfn_analysis.rb', line 10295

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 



10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
 
# File 'quick_sight/cfn_analysis.rb', line 10307

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