Class: AWSCDK::QuickSight::CfnDashboard::FilterListControlProperty

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



10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
 
# File 'quick_sight/cfn_dashboard.rb', line 10992

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



11028
11029
11030
 
# File 'quick_sight/cfn_dashboard.rb', line 11028

def cascading_control_configuration
  @cascading_control_configuration
end

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

The display options of a control.

Returns:

See Also:



11033
11034
11035
 
# File 'quick_sight/cfn_dashboard.rb', line 11033

def display_options
  @display_options
end

#filter_control_id ⇒ String (readonly)

The ID of the FilterListControl .

Returns:

  • (String)

See Also:



11013
11014
11015
 
# File 'quick_sight/cfn_dashboard.rb', line 11013

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:



11038
11039
11040
 
# File 'quick_sight/cfn_dashboard.rb', line 11038

def selectable_values
  @selectable_values
end

#source_filter_id ⇒ String (readonly)

The source filter ID of the FilterListControl .

Returns:

  • (String)

See Also:



11018
11019
11020
 
# File 'quick_sight/cfn_dashboard.rb', line 11018

def source_filter_id
  @source_filter_id
end

#title ⇒ String (readonly)

The title of the FilterListControl .

Returns:

  • (String)

See Also:



11023
11024
11025
 
# File 'quick_sight/cfn_dashboard.rb', line 11023

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:



11046
11047
11048
 
# File 'quick_sight/cfn_dashboard.rb', line 11046

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
 
# File 'quick_sight/cfn_dashboard.rb', line 11048

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 



11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
 
# File 'quick_sight/cfn_dashboard.rb', line 11060

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