Class: AWSCDK::QuickSight::CfnTemplate::DefaultSliderControlOptionsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTemplate::DefaultSliderControlOptionsProperty

Defined in:

quick_sight/cfn_template.rb

Overview

The default options that correspond to the Slider filter control type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html

Instance Attribute Summary

• #display_options ⇒ AWSCDK::IResolvable, ... readonly

  The display options of a control.

• #maximum_value ⇒ Numeric readonly

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

• #minimum_value ⇒ Numeric readonly

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

• #step_size ⇒ Numeric readonly

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

• #type ⇒ String^? readonly

  The type of the DefaultSliderControlOptions .

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(maximum_value:, minimum_value:, step_size:, display_options: nil, type: nil) ⇒ DefaultSliderControlOptionsProperty constructor

  A new instance of DefaultSliderControlOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(maximum_value:, minimum_value:, step_size:, display_options: nil, type: nil) ⇒ DefaultSliderControlOptionsProperty

Returns a new instance of DefaultSliderControlOptionsProperty.

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.

• step_size (Numeric) —

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

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

  The display options of a control.

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

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

# File 'quick_sight/cfn_template.rb', line 8068

def initialize(maximum_value:, minimum_value:, step_size:, display_options: nil, type: 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")
  @step_size = step_size
  Jsii::Type.check_type(@step_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "stepSize")
  @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?
  @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:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::SliderControlDisplayOptionsProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html#cfn-quicksight-template-defaultslidercontroloptions-displayoptions

# File 'quick_sight/cfn_template.rb', line 8103

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html#cfn-quicksight-template-defaultslidercontroloptions-maximumvalue

# File 'quick_sight/cfn_template.rb', line 8086

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html#cfn-quicksight-template-defaultslidercontroloptions-minimumvalue

# File 'quick_sight/cfn_template.rb', line 8092

def minimum_value
  @minimum_value
end

#step_size ⇒ Numeric (readonly)

Note:

Default: - 0

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

Returns:

• (Numeric)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html#cfn-quicksight-template-defaultslidercontroloptions-stepsize

# File 'quick_sight/cfn_template.rb', line 8098

def step_size
  @step_size
end

#type ⇒ String^? (readonly)

The type of the DefaultSliderControlOptions . 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html#cfn-quicksight-template-defaultslidercontroloptions-type

# File 'quick_sight/cfn_template.rb', line 8111

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_template.rb', line 8113

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

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_template.rb', line 8123

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