Class: AWSCDK::QuickSight::CfnDashboard::DefaultSliderControlOptionsProperty

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

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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::CfnDashboard::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:.



8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
 
# File 'quick_sight/cfn_dashboard.rb', line 8881

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::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:



8916
8917
8918
 
# File 'quick_sight/cfn_dashboard.rb', line 8916

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:



8899
8900
8901
 
# File 'quick_sight/cfn_dashboard.rb', line 8899

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:



8905
8906
8907
 
# File 'quick_sight/cfn_dashboard.rb', line 8905

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:



8911
8912
8913
 
# File 'quick_sight/cfn_dashboard.rb', line 8911

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:



8924
8925
8926
 
# File 'quick_sight/cfn_dashboard.rb', line 8924

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



8926
8927
8928
8929
8930
8931
8932
8933
8934
 
# File 'quick_sight/cfn_dashboard.rb', line 8926

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 



8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
 
# File 'quick_sight/cfn_dashboard.rb', line 8936

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