Class: AWSCDK::QuickSight::CfnAnalysis::FunnelChartVisualProperty

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

Overview

A funnel chart.

For more information, see Using funnel 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) ⇒ FunnelChartVisualProperty

Returns a new instance of FunnelChartVisualProperty.

Parameters:



12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
 
# File 'quick_sight/cfn_analysis.rb', line 12066

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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5WaXN1YWxDdXN0b21BY3Rpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "actions") unless @actions.nil?
  @chart_configuration = chart_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::FunnelChartConfigurationProperty.new(**chart_configuration.transform_keys(&:to_sym)) : chart_configuration
  Jsii::Type.check_type(@chart_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkZ1bm5lbENoYXJ0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "chartConfiguration") unless @chart_configuration.nil?
  @column_hierarchies = column_hierarchies
  Jsii::Type.check_type(@column_hierarchies, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5Db2x1bW5IaWVyYXJjaHlQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "columnHierarchies") unless @column_hierarchies.nil?
  @subtitle = subtitle.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::VisualSubtitleLabelOptionsProperty.new(**subtitle.transform_keys(&:to_sym)) : subtitle
  Jsii::Type.check_type(@subtitle, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlZpc3VhbFN1YnRpdGxlTGFiZWxPcHRpb25zUHJvcGVydHkifV19fQ==")), "subtitle") unless @subtitle.nil?
  @title = title.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::VisualTitleLabelOptionsProperty.new(**title.transform_keys(&:to_sym)) : title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlZpc3VhbFRpdGxlTGFiZWxPcHRpb25zUHJvcGVydHkifV19fQ==")), "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:



12094
12095
12096
 
# File 'quick_sight/cfn_analysis.rb', line 12094

def actions
  @actions
end

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

The configuration of a FunnelChartVisual .

Returns:

See Also:



12099
12100
12101
 
# File 'quick_sight/cfn_analysis.rb', line 12099

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:



12104
12105
12106
 
# File 'quick_sight/cfn_analysis.rb', line 12104

def column_hierarchies
  @column_hierarchies
end

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

The subtitle that is displayed on the visual.

Returns:

See Also:



12109
12110
12111
 
# File 'quick_sight/cfn_analysis.rb', line 12109

def subtitle
  @subtitle
end

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

The title that is displayed on the visual.

Returns:

See Also:



12114
12115
12116
 
# File 'quick_sight/cfn_analysis.rb', line 12114

def title
  @title
end

#visual_content_alt_text ⇒ String? (readonly)

The alt text for the visual.

Returns:

  • (String, nil)

See Also:



12119
12120
12121
 
# File 'quick_sight/cfn_analysis.rb', line 12119

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:



12089
12090
12091
 
# File 'quick_sight/cfn_analysis.rb', line 12089

def visual_id
  @visual_id
end

Class Method Details

.jsii_properties ⇒ Object 



12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
 
# File 'quick_sight/cfn_analysis.rb', line 12121

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 



12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
 
# File 'quick_sight/cfn_analysis.rb', line 12133

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