Class: AWSCDK::QuickSight::CfnDashboard::KPIOptionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_dashboard.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:



17621
17622
17623
17624
17625
17626
17627
17628
17629
17630
17631
17632
17633
17634
17635
17636
17637
17638
17639
17640
 
# File 'quick_sight/cfn_dashboard.rb', line 17621

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::CfnDashboard::ComparisonConfigurationProperty.new(**comparison.transform_keys(&:to_sym)) : comparison
  Jsii::Type.check_type(@comparison, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Db21wYXJpc29uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "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::CfnDashboard::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Gb250Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "primaryValueFontConfiguration") unless @primary_value_font_configuration.nil?
  @progress_bar = progress_bar.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ProgressBarOptionsProperty.new(**progress_bar.transform_keys(&:to_sym)) : progress_bar
  Jsii::Type.check_type(@progress_bar, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Qcm9ncmVzc0Jhck9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "progressBar") unless @progress_bar.nil?
  @secondary_value = secondary_value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::SecondaryValueOptionsProperty.new(**secondary_value.transform_keys(&:to_sym)) : secondary_value
  Jsii::Type.check_type(@secondary_value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5TZWNvbmRhcnlWYWx1ZU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "secondaryValue") unless @secondary_value.nil?
  @secondary_value_font_configuration = secondary_value_font_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Gb250Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "secondaryValueFontConfiguration") unless @secondary_value_font_configuration.nil?
  @sparkline = sparkline.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::KPISparklineOptionsProperty.new(**sparkline.transform_keys(&:to_sym)) : sparkline
  Jsii::Type.check_type(@sparkline, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5LUElTcGFya2xpbmVPcHRpb25zUHJvcGVydHkifV19fQ==")), "sparkline") unless @sparkline.nil?
  @trend_arrows = trend_arrows.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::TrendArrowOptionsProperty.new(**trend_arrows.transform_keys(&:to_sym)) : trend_arrows
  Jsii::Type.check_type(@trend_arrows, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5UcmVuZEFycm93T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "trendArrows") unless @trend_arrows.nil?
  @visual_layout_options = visual_layout_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::KPIVisualLayoutOptionsProperty.new(**visual_layout_options.transform_keys(&:to_sym)) : visual_layout_options
  Jsii::Type.check_type(@visual_layout_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5LUElWaXN1YWxMYXlvdXRPcHRpb25zUHJvcGVydHkifV19fQ==")), "visualLayoutOptions") unless @visual_layout_options.nil?
end

Instance Attribute Details

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

The comparison configuration of a KPI visual.

Returns:

See Also:



17646
17647
17648
 
# File 'quick_sight/cfn_dashboard.rb', line 17646

def comparison
  @comparison
end

#primary_value_display_type ⇒ String? (readonly)

The options that determine the primary value display type.

Returns:

  • (String, nil)

See Also:



17651
17652
17653
 
# File 'quick_sight/cfn_dashboard.rb', line 17651

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:



17656
17657
17658
 
# File 'quick_sight/cfn_dashboard.rb', line 17656

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:



17661
17662
17663
 
# File 'quick_sight/cfn_dashboard.rb', line 17661

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:



17666
17667
17668
 
# File 'quick_sight/cfn_dashboard.rb', line 17666

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:



17671
17672
17673
 
# File 'quick_sight/cfn_dashboard.rb', line 17671

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:



17676
17677
17678
 
# File 'quick_sight/cfn_dashboard.rb', line 17676

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:



17681
17682
17683
 
# File 'quick_sight/cfn_dashboard.rb', line 17681

def trend_arrows
  @trend_arrows
end

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

The options that determine the layout a KPI visual.

Returns:

See Also:



17686
17687
17688
 
# File 'quick_sight/cfn_dashboard.rb', line 17686

def visual_layout_options
  @visual_layout_options
end

Class Method Details

.jsii_properties ⇒ Object 



17688
17689
17690
17691
17692
17693
17694
17695
17696
17697
17698
17699
17700
 
# File 'quick_sight/cfn_dashboard.rb', line 17688

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 



17702
17703
17704
17705
17706
17707
17708
17709
17710
17711
17712
17713
17714
17715
17716
 
# File 'quick_sight/cfn_dashboard.rb', line 17702

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