Class: AWSCDK::QuickSight::CfnTemplate::KPIOptionsProperty

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

Overview

The options that determine the presentation of a KPI visual.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(comparison: nil, primary_value_display_type: nil, primary_value_font_configuration: nil, progress_bar: nil, secondary_value: nil, secondary_value_font_configuration: nil, sparkline: nil, trend_arrows: nil, visual_layout_options: nil) ⇒ KPIOptionsProperty

Returns a new instance of KPIOptionsProperty.

Parameters:



15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
15104
15105
15106
15107
15108
 
# File 'quick_sight/cfn_template.rb', line 15089

def initialize(comparison: nil, primary_value_display_type: nil, primary_value_font_configuration: nil, progress_bar: nil, secondary_value: nil, secondary_value_font_configuration: nil, sparkline: nil, trend_arrows: nil, visual_layout_options: nil)
  @comparison = comparison.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ComparisonConfigurationProperty.new(**comparison.transform_keys(&:to_sym)) : comparison
  Jsii::Type.check_type(@comparison, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNvbXBhcmlzb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "comparison") unless @comparison.nil?
  @primary_value_display_type = primary_value_display_type
  Jsii::Type.check_type(@primary_value_display_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "primaryValueDisplayType") unless @primary_value_display_type.nil?
  @primary_value_font_configuration = primary_value_font_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FontConfigurationProperty.new(**primary_value_font_configuration.transform_keys(&:to_sym)) : primary_value_font_configuration
  Jsii::Type.check_type(@primary_value_font_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZvbnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "primaryValueFontConfiguration") unless @primary_value_font_configuration.nil?
  @progress_bar = progress_bar.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ProgressBarOptionsProperty.new(**progress_bar.transform_keys(&:to_sym)) : progress_bar
  Jsii::Type.check_type(@progress_bar, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlByb2dyZXNzQmFyT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "progressBar") unless @progress_bar.nil?
  @secondary_value = secondary_value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::SecondaryValueOptionsProperty.new(**secondary_value.transform_keys(&:to_sym)) : secondary_value
  Jsii::Type.check_type(@secondary_value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlNlY29uZGFyeVZhbHVlT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "secondaryValue") unless @secondary_value.nil?
  @secondary_value_font_configuration = secondary_value_font_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FontConfigurationProperty.new(**secondary_value_font_configuration.transform_keys(&:to_sym)) : secondary_value_font_configuration
  Jsii::Type.check_type(@secondary_value_font_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZvbnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "secondaryValueFontConfiguration") unless @secondary_value_font_configuration.nil?
  @sparkline = sparkline.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::KPISparklineOptionsProperty.new(**sparkline.transform_keys(&:to_sym)) : sparkline
  Jsii::Type.check_type(@sparkline, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLktQSVNwYXJrbGluZU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "sparkline") unless @sparkline.nil?
  @trend_arrows = trend_arrows.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::TrendArrowOptionsProperty.new(**trend_arrows.transform_keys(&:to_sym)) : trend_arrows
  Jsii::Type.check_type(@trend_arrows, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRyZW5kQXJyb3dPcHRpb25zUHJvcGVydHkifV19fQ==")), "trendArrows") unless @trend_arrows.nil?
  @visual_layout_options = visual_layout_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::KPIVisualLayoutOptionsProperty.new(**visual_layout_options.transform_keys(&:to_sym)) : visual_layout_options
  Jsii::Type.check_type(@visual_layout_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLktQSVZpc3VhbExheW91dE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "visualLayoutOptions") unless @visual_layout_options.nil?
end

Instance Attribute Details

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

The comparison configuration of a KPI visual.

Returns:

See Also:



15114
15115
15116
 
# File 'quick_sight/cfn_template.rb', line 15114

def comparison
  @comparison
end

#primary_value_display_type ⇒ String? (readonly)

The options that determine the primary value display type.

Returns:

  • (String, nil)

See Also:



15119
15120
15121
 
# File 'quick_sight/cfn_template.rb', line 15119

def primary_value_display_type
  @primary_value_display_type
end

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

The options that determine the primary value font configuration.

Returns:

See Also:



15124
15125
15126
 
# File 'quick_sight/cfn_template.rb', line 15124

def primary_value_font_configuration
  @primary_value_font_configuration
end

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

The options that determine the presentation of the progress bar of a KPI visual.

Returns:

See Also:



15129
15130
15131
 
# File 'quick_sight/cfn_template.rb', line 15129

def progress_bar
  @progress_bar
end

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

The options that determine the presentation of the secondary value of a KPI visual.

Returns:

See Also:



15134
15135
15136
 
# File 'quick_sight/cfn_template.rb', line 15134

def secondary_value
  @secondary_value
end

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

The options that determine the secondary value font configuration.

Returns:

See Also:



15139
15140
15141
 
# File 'quick_sight/cfn_template.rb', line 15139

def secondary_value_font_configuration
  @secondary_value_font_configuration
end

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

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

Returns:

See Also:



15144
15145
15146
 
# File 'quick_sight/cfn_template.rb', line 15144

def sparkline
  @sparkline
end

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

The options that determine the presentation of trend arrows in a KPI visual.

Returns:

See Also:



15149
15150
15151
 
# File 'quick_sight/cfn_template.rb', line 15149

def trend_arrows
  @trend_arrows
end

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

The options that determine the layout a KPI visual.

Returns:

See Also:



15154
15155
15156
 
# File 'quick_sight/cfn_template.rb', line 15154

def visual_layout_options
  @visual_layout_options
end

Class Method Details

.jsii_properties ⇒ Object 



15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
 
# File 'quick_sight/cfn_template.rb', line 15156

def self.jsii_properties
  {
    :comparison => "comparison",
    :primary_value_display_type => "primaryValueDisplayType",
    :primary_value_font_configuration => "primaryValueFontConfiguration",
    :progress_bar => "progressBar",
    :secondary_value => "secondaryValue",
    :secondary_value_font_configuration => "secondaryValueFontConfiguration",
    :sparkline => "sparkline",
    :trend_arrows => "trendArrows",
    :visual_layout_options => "visualLayoutOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



15170
15171
15172
15173
15174
15175
15176
15177
15178
15179
15180
15181
15182
15183
15184
 
# File 'quick_sight/cfn_template.rb', line 15170

def to_jsii
  result = {}
  result.merge!({
    "comparison" => @comparison,
    "primaryValueDisplayType" => @primary_value_display_type,
    "primaryValueFontConfiguration" => @primary_value_font_configuration,
    "progressBar" => @progress_bar,
    "secondaryValue" => @secondary_value,
    "secondaryValueFontConfiguration" => @secondary_value_font_configuration,
    "sparkline" => @sparkline,
    "trendArrows" => @trend_arrows,
    "visualLayoutOptions" => @visual_layout_options,
  })
  result.compact
end