Class: AWSCDK::QuickSight::CfnTemplate::ParameterSliderControlProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_template.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(maximum_value:, minimum_value:, parameter_control_id:, source_parameter_name:, step_size:, title:, display_options: nil) ⇒ ParameterSliderControlProperty

Returns a new instance of ParameterSliderControlProperty.

Parameters:

  • 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.

  • parameter_control_id (String) —

    The ID of the ParameterSliderControl .

  • source_parameter_name (String) —

    The source parameter name of the ParameterSliderControl .

  • step_size (Numeric) —

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

  • title (String) —

    The title of the ParameterSliderControl .

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

    The display options of a control.



18746
18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
 
# File 'quick_sight/cfn_template.rb', line 18746

def initialize(maximum_value:, minimum_value:, parameter_control_id:, source_parameter_name:, step_size:, title:, display_options: nil)
  @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")
  @parameter_control_id = parameter_control_id
  Jsii::Type.check_type(@parameter_control_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterControlId")
  @source_parameter_name = source_parameter_name
  Jsii::Type.check_type(@source_parameter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceParameterName")
  @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::CfnTemplate::SliderControlDisplayOptionsProperty.new(**display_options.transform_keys(&:to_sym)) : display_options
  Jsii::Type.check_type(@display_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlNsaWRlckNvbnRyb2xEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "displayOptions") unless @display_options.nil?
end

Instance Attribute Details

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

The display options of a control.

Returns:

See Also:



18800
18801
18802
 
# File 'quick_sight/cfn_template.rb', line 18800

def display_options
  @display_options
end

#maximum_value ⇒ Numeric (readonly)

Note:

Default: - 0

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

Returns:

  • (Numeric)

See Also:



18768
18769
18770
 
# File 'quick_sight/cfn_template.rb', line 18768

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:



18774
18775
18776
 
# File 'quick_sight/cfn_template.rb', line 18774

def minimum_value
  @minimum_value
end

#parameter_control_id ⇒ String (readonly)

The ID of the ParameterSliderControl .

Returns:

  • (String)

See Also:



18779
18780
18781
 
# File 'quick_sight/cfn_template.rb', line 18779

def parameter_control_id
  @parameter_control_id
end

#source_parameter_name ⇒ String (readonly)

The source parameter name of the ParameterSliderControl .

Returns:

  • (String)

See Also:



18784
18785
18786
 
# File 'quick_sight/cfn_template.rb', line 18784

def source_parameter_name
  @source_parameter_name
end

#step_size ⇒ Numeric (readonly)

Note:

Default: - 0

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

Returns:

  • (Numeric)

See Also:



18790
18791
18792
 
# File 'quick_sight/cfn_template.rb', line 18790

def step_size
  @step_size
end

#title ⇒ String (readonly)

The title of the ParameterSliderControl .

Returns:

  • (String)

See Also:



18795
18796
18797
 
# File 'quick_sight/cfn_template.rb', line 18795

def title
  @title
end

Class Method Details

.jsii_properties ⇒ Object 



18802
18803
18804
18805
18806
18807
18808
18809
18810
18811
18812
 
# File 'quick_sight/cfn_template.rb', line 18802

def self.jsii_properties
  {
    :maximum_value => "maximumValue",
    :minimum_value => "minimumValue",
    :parameter_control_id => "parameterControlId",
    :source_parameter_name => "sourceParameterName",
    :step_size => "stepSize",
    :title => "title",
    :display_options => "displayOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



18814
18815
18816
18817
18818
18819
18820
18821
18822
18823
18824
18825
18826
 
# File 'quick_sight/cfn_template.rb', line 18814

def to_jsii
  result = {}
  result.merge!({
    "maximumValue" => @maximum_value,
    "minimumValue" => @minimum_value,
    "parameterControlId" => @parameter_control_id,
    "sourceParameterName" => @source_parameter_name,
    "stepSize" => @step_size,
    "title" => @title,
    "displayOptions" => @display_options,
  })
  result.compact
end