Class: AWSCDK::QuickSight::CfnDashboard::FilterSliderControlProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_dashboard.rb

Overview

A control to display a horizontal toggle bar.

This is used to change a value by sliding the toggle.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(filter_control_id:, maximum_value:, minimum_value:, source_filter_id:, step_size:, title:, display_options: nil, type: nil) ⇒ FilterSliderControlProperty

Returns a new instance of FilterSliderControlProperty.

Parameters:

  • filter_control_id (String) —

    The ID of the FilterSliderControl .

  • maximum_value (Numeric) —

    The larger value that is displayed at the right of the slider.

  • minimum_value (Numeric) —

    The smaller value that is displayed at the left of the slider.

  • source_filter_id (String) —

    The source filter ID of the FilterSliderControl .

  • step_size (Numeric) —

    The number of increments that the slider bar is divided into.

  • title (String) —

    The title of the FilterSliderControl .

  • display_options (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::SliderControlDisplayOptionsProperty, nil) (defaults to: nil) —

    The display options of a control.

  • type (String, nil) (defaults to: nil) —

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



11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
 
# File 'quick_sight/cfn_dashboard.rb', line 11445

def initialize(filter_control_id:, maximum_value:, minimum_value:, source_filter_id:, step_size:, title:, display_options: nil, type: nil)
  @filter_control_id = filter_control_id
  Jsii::Type.check_type(@filter_control_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterControlId")
  @maximum_value = maximum_value
  Jsii::Type.check_type(@maximum_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumValue")
  @minimum_value = minimum_value
  Jsii::Type.check_type(@minimum_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minimumValue")
  @source_filter_id = source_filter_id
  Jsii::Type.check_type(@source_filter_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceFilterId")
  @step_size = step_size
  Jsii::Type.check_type(@step_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "stepSize")
  @title = title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "title")
  @display_options = display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::SliderControlDisplayOptionsProperty.new(**display_options.transform_keys(&:to_sym)) : display_options
  Jsii::Type.check_type(@display_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5TbGlkZXJDb250cm9sRGlzcGxheU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "displayOptions") unless @display_options.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

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

The display options of a control.

Returns:

See Also:



11501
11502
11503
 
# File 'quick_sight/cfn_dashboard.rb', line 11501

def display_options
  @display_options
end

#filter_control_id ⇒ String (readonly)

The ID of the FilterSliderControl .

Returns:

  • (String)

See Also:



11468
11469
11470
 
# File 'quick_sight/cfn_dashboard.rb', line 11468

def filter_control_id
  @filter_control_id
end

#maximum_value ⇒ Numeric (readonly)

Note:

Default: - 0

The larger value that is displayed at the right of the slider.

Returns:

  • (Numeric)

See Also:



11474
11475
11476
 
# File 'quick_sight/cfn_dashboard.rb', line 11474

def maximum_value
  @maximum_value
end

#minimum_value ⇒ Numeric (readonly)

Note:

Default: - 0

The smaller value that is displayed at the left of the slider.

Returns:

  • (Numeric)

See Also:



11480
11481
11482
 
# File 'quick_sight/cfn_dashboard.rb', line 11480

def minimum_value
  @minimum_value
end

#source_filter_id ⇒ String (readonly)

The source filter ID of the FilterSliderControl .

Returns:

  • (String)

See Also:



11485
11486
11487
 
# File 'quick_sight/cfn_dashboard.rb', line 11485

def source_filter_id
  @source_filter_id
end

#step_size ⇒ Numeric (readonly)

Note:

Default: - 0

The number of increments that the slider bar is divided into.

Returns:

  • (Numeric)

See Also:



11491
11492
11493
 
# File 'quick_sight/cfn_dashboard.rb', line 11491

def step_size
  @step_size
end

#title ⇒ String (readonly)

The title of the FilterSliderControl .

Returns:

  • (String)

See Also:



11496
11497
11498
 
# File 'quick_sight/cfn_dashboard.rb', line 11496

def title
  @title
end

#type ⇒ String? (readonly)

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

  • SINGLE_POINT : Filter against(equals) a single data point.
  • RANGE : Filter data that is in a specified range.

Returns:

  • (String, nil)

See Also:



11509
11510
11511
 
# File 'quick_sight/cfn_dashboard.rb', line 11509

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
 
# File 'quick_sight/cfn_dashboard.rb', line 11511

def self.jsii_properties
  {
    :filter_control_id => "filterControlId",
    :maximum_value => "maximumValue",
    :minimum_value => "minimumValue",
    :source_filter_id => "sourceFilterId",
    :step_size => "stepSize",
    :title => "title",
    :display_options => "displayOptions",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
 
# File 'quick_sight/cfn_dashboard.rb', line 11524

def to_jsii
  result = {}
  result.merge!({
    "filterControlId" => @filter_control_id,
    "maximumValue" => @maximum_value,
    "minimumValue" => @minimum_value,
    "sourceFilterId" => @source_filter_id,
    "stepSize" => @step_size,
    "title" => @title,
    "displayOptions" => @display_options,
    "type" => @type,
  })
  result.compact
end