Class: AWSCDK::QuickSight::CfnDashboard::ComparisonConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnDashboard::ComparisonConfigurationProperty

Defined in:

quick_sight/cfn_dashboard.rb

Overview

The comparison display configuration of a KPI or gauge chart.

See Also:

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

Instance Attribute Summary

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

  The format of the comparison.

• #comparison_method ⇒ String^? readonly

  The method of the comparison.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(comparison_format: nil, comparison_method: nil) ⇒ ComparisonConfigurationProperty constructor

  A new instance of ComparisonConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(comparison_format: nil, comparison_method: nil) ⇒ ComparisonConfigurationProperty

Returns a new instance of ComparisonConfigurationProperty.

Parameters:

• comparison_format (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::ComparisonFormatConfigurationProperty, nil) (defaults to: nil) —

  The format of the comparison.

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

  The method of the comparison. Choose from the following options:.

# File 'quick_sight/cfn_dashboard.rb', line 4622

def initialize(comparison_format: nil, comparison_method: nil)
  @comparison_format = comparison_format.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ComparisonFormatConfigurationProperty.new(**comparison_format.transform_keys(&:to_sym)) : comparison_format
  Jsii::Type.check_type(@comparison_format, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Db21wYXJpc29uRm9ybWF0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "comparisonFormat") unless @comparison_format.nil?
  @comparison_method = comparison_method
  Jsii::Type.check_type(@comparison_method, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "comparisonMethod") unless @comparison_method.nil?
end

Instance Attribute Details

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

The format of the comparison.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::ComparisonFormatConfigurationProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-comparisonconfiguration.html#cfn-quicksight-dashboard-comparisonconfiguration-comparisonformat

# File 'quick_sight/cfn_dashboard.rb', line 4633

def comparison_format
  @comparison_format
end

#comparison_method ⇒ String^? (readonly)

The method of the comparison. Choose from the following options:.

• DIFFERENCE
• PERCENT_DIFFERENCE
• PERCENT

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-comparisonconfiguration.html#cfn-quicksight-dashboard-comparisonconfiguration-comparisonmethod

# File 'quick_sight/cfn_dashboard.rb', line 4642

def comparison_method
  @comparison_method
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_dashboard.rb', line 4644

def self.jsii_properties
  {
    :comparison_format => "comparisonFormat",
    :comparison_method => "comparisonMethod",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_dashboard.rb', line 4651

def to_jsii
  result = {}
  result.merge!({
    "comparisonFormat" => @comparison_format,
    "comparisonMethod" => @comparison_method,
  })
  result.compact
end