Class: AWSCDK::QuickSight::CfnTemplate::HistogramBinOptionsProperty

Inherits:

Jsii::Struct

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

Defined in:

quick_sight/cfn_template.rb

Overview

The options that determine the presentation of histogram bins.

See Also:

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

Instance Attribute Summary

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

  The options that determine the bin count of a histogram.

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

  The options that determine the bin width of a histogram.

• #selected_bin_type ⇒ String^? readonly

  The options that determine the selected bin type.

• #start_value ⇒ Numeric^? readonly

  The options that determine the bin start value.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(bin_count: nil, bin_width: nil, selected_bin_type: nil, start_value: nil) ⇒ HistogramBinOptionsProperty constructor

  A new instance of HistogramBinOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(bin_count: nil, bin_width: nil, selected_bin_type: nil, start_value: nil) ⇒ HistogramBinOptionsProperty

Returns a new instance of HistogramBinOptionsProperty.

Parameters:

• bin_count (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::BinCountOptionsProperty, nil) (defaults to: nil) —

  The options that determine the bin count of a histogram.

• bin_width (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::BinWidthOptionsProperty, nil) (defaults to: nil) —

  The options that determine the bin width of a histogram.

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

  The options that determine the selected bin type.

• start_value (Numeric, nil) (defaults to: nil) —

  The options that determine the bin start value.

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

def initialize(bin_count: nil, bin_width: nil, selected_bin_type: nil, start_value: nil)
  @bin_count = bin_count.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::BinCountOptionsProperty.new(**bin_count.transform_keys(&:to_sym)) : bin_count
  Jsii::Type.check_type(@bin_count, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkJpbkNvdW50T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "binCount") unless @bin_count.nil?
  @bin_width = bin_width.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::BinWidthOptionsProperty.new(**bin_width.transform_keys(&:to_sym)) : bin_width
  Jsii::Type.check_type(@bin_width, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkJpbldpZHRoT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "binWidth") unless @bin_width.nil?
  @selected_bin_type = selected_bin_type
  Jsii::Type.check_type(@selected_bin_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "selectedBinType") unless @selected_bin_type.nil?
  @start_value = start_value
  Jsii::Type.check_type(@start_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "startValue") unless @start_value.nil?
end

Instance Attribute Details

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

The options that determine the bin count of a histogram.

Returns:

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

See Also:

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

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

def bin_count
  @bin_count
end

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

The options that determine the bin width of a histogram.

Returns:

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

See Also:

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

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

def bin_width
  @bin_width
end

#selected_bin_type ⇒ String^? (readonly)

The options that determine the selected bin type.

Returns:

• (String, nil)

See Also:

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

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

def selected_bin_type
  @selected_bin_type
end

#start_value ⇒ Numeric^? (readonly)

The options that determine the bin start value.

Returns:

• (Numeric, nil)

See Also:

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

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

def start_value
  @start_value
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :bin_count => "binCount",
    :bin_width => "binWidth",
    :selected_bin_type => "selectedBinType",
    :start_value => "startValue",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "binCount" => @bin_count,
    "binWidth" => @bin_width,
    "selectedBinType" => @selected_bin_type,
    "startValue" => @start_value,
  })
  result.compact
end