Class: AWSCDK::QuickSight::CfnDashboard::WaterfallVisualProperty

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

Overview

A waterfall chart.

For more information, see Using waterfall charts in the Amazon Quick Suite User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(visual_id:, actions: nil, chart_configuration: nil, column_hierarchies: nil, subtitle: nil, title: nil, visual_content_alt_text: nil) ⇒ WaterfallVisualProperty

Returns a new instance of WaterfallVisualProperty.

Parameters:



33071
33072
33073
33074
33075
33076
33077
33078
33079
33080
33081
33082
33083
33084
33085
33086
 
# File 'quick_sight/cfn_dashboard.rb', line 33071

def initialize(visual_id:, actions: nil, chart_configuration: nil, column_hierarchies: nil, subtitle: nil, title: nil, visual_content_alt_text: nil)
  @visual_id = visual_id
  Jsii::Type.check_type(@visual_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visualId")
  @actions = actions
  Jsii::Type.check_type(@actions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuVmlzdWFsQ3VzdG9tQWN0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "actions") unless @actions.nil?
  @chart_configuration = chart_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::WaterfallChartConfigurationProperty.new(**chart_configuration.transform_keys(&:to_sym)) : chart_configuration
  Jsii::Type.check_type(@chart_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5XYXRlcmZhbGxDaGFydENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "chartConfiguration") unless @chart_configuration.nil?
  @column_hierarchies = column_hierarchies
  Jsii::Type.check_type(@column_hierarchies, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuQ29sdW1uSGllcmFyY2h5UHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "columnHierarchies") unless @column_hierarchies.nil?
  @subtitle = subtitle.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::VisualSubtitleLabelOptionsProperty.new(**subtitle.transform_keys(&:to_sym)) : subtitle
  Jsii::Type.check_type(@subtitle, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5WaXN1YWxTdWJ0aXRsZUxhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "subtitle") unless @subtitle.nil?
  @title = title.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::VisualTitleLabelOptionsProperty.new(**title.transform_keys(&:to_sym)) : title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5WaXN1YWxUaXRsZUxhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "title") unless @title.nil?
  @visual_content_alt_text = visual_content_alt_text
  Jsii::Type.check_type(@visual_content_alt_text, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visualContentAltText") unless @visual_content_alt_text.nil?
end

Instance Attribute Details

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

The list of custom actions that are configured for a visual.

Returns:

See Also:



33099
33100
33101
 
# File 'quick_sight/cfn_dashboard.rb', line 33099

def actions
  @actions
end

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

The configuration for a waterfall visual.

Returns:

See Also:



33104
33105
33106
 
# File 'quick_sight/cfn_dashboard.rb', line 33104

def chart_configuration
  @chart_configuration
end

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

The column hierarchy that is used during drill-downs and drill-ups.

Returns:

See Also:



33109
33110
33111
 
# File 'quick_sight/cfn_dashboard.rb', line 33109

def column_hierarchies
  @column_hierarchies
end

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

The subtitle that is displayed on the visual.

Returns:

See Also:



33114
33115
33116
 
# File 'quick_sight/cfn_dashboard.rb', line 33114

def subtitle
  @subtitle
end

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

The title that is displayed on the visual.

Returns:

See Also:



33119
33120
33121
 
# File 'quick_sight/cfn_dashboard.rb', line 33119

def title
  @title
end

#visual_content_alt_text ⇒ String? (readonly)

The alt text for the visual.

Returns:

  • (String, nil)

See Also:



33124
33125
33126
 
# File 'quick_sight/cfn_dashboard.rb', line 33124

def visual_content_alt_text
  @visual_content_alt_text
end

#visual_id ⇒ String (readonly)

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

Returns:

  • (String)

See Also:



33094
33095
33096
 
# File 'quick_sight/cfn_dashboard.rb', line 33094

def visual_id
  @visual_id
end

Class Method Details

.jsii_properties ⇒ Object 



33126
33127
33128
33129
33130
33131
33132
33133
33134
33135
33136
 
# File 'quick_sight/cfn_dashboard.rb', line 33126

def self.jsii_properties
  {
    :visual_id => "visualId",
    :actions => "actions",
    :chart_configuration => "chartConfiguration",
    :column_hierarchies => "columnHierarchies",
    :subtitle => "subtitle",
    :title => "title",
    :visual_content_alt_text => "visualContentAltText",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



33138
33139
33140
33141
33142
33143
33144
33145
33146
33147
33148
33149
33150
 
# File 'quick_sight/cfn_dashboard.rb', line 33138

def to_jsii
  result = {}
  result.merge!({
    "visualId" => @visual_id,
    "actions" => @actions,
    "chartConfiguration" => @chart_configuration,
    "columnHierarchies" => @column_hierarchies,
    "subtitle" => @subtitle,
    "title" => @title,
    "visualContentAltText" => @visual_content_alt_text,
  })
  result.compact
end