Class: AWSCDK::QuickSight::CfnTemplate::HeatMapConfigurationProperty

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

Overview

The configuration of a heat map.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(color_scale: nil, column_label_options: nil, data_labels: nil, field_wells: nil, interactions: nil, legend: nil, row_label_options: nil, sort_configuration: nil, tooltip: nil) ⇒ HeatMapConfigurationProperty

Returns a new instance of HeatMapConfigurationProperty.

Parameters:



13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
# File 'quick_sight/cfn_template.rb', line 13558

def initialize(color_scale: nil, column_label_options: nil, data_labels: nil, field_wells: nil, interactions: nil, legend: nil, row_label_options: nil, sort_configuration: nil, tooltip: nil)
  @color_scale = color_scale.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ColorScaleProperty.new(**color_scale.transform_keys(&:to_sym)) : color_scale
  Jsii::Type.check_type(@color_scale, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNvbG9yU2NhbGVQcm9wZXJ0eSJ9XX19")), "colorScale") unless @color_scale.nil?
  @column_label_options = column_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ChartAxisLabelOptionsProperty.new(**column_label_options.transform_keys(&:to_sym)) : column_label_options
  Jsii::Type.check_type(@column_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "columnLabelOptions") unless @column_label_options.nil?
  @data_labels = data_labels.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::DataLabelOptionsProperty.new(**data_labels.transform_keys(&:to_sym)) : data_labels
  Jsii::Type.check_type(@data_labels, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkRhdGFMYWJlbE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "dataLabels") unless @data_labels.nil?
  @field_wells = field_wells.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::HeatMapFieldWellsProperty.new(**field_wells.transform_keys(&:to_sym)) : field_wells
  Jsii::Type.check_type(@field_wells, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkhlYXRNYXBGaWVsZFdlbGxzUHJvcGVydHkifV19fQ==")), "fieldWells") unless @field_wells.nil?
  @interactions = interactions.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::VisualInteractionOptionsProperty.new(**interactions.transform_keys(&:to_sym)) : interactions
  Jsii::Type.check_type(@interactions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlZpc3VhbEludGVyYWN0aW9uT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "interactions") unless @interactions.nil?
  @legend = legend.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::LegendOptionsProperty.new(**legend.transform_keys(&:to_sym)) : legend
  Jsii::Type.check_type(@legend, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkxlZ2VuZE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "legend") unless @legend.nil?
  @row_label_options = row_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ChartAxisLabelOptionsProperty.new(**row_label_options.transform_keys(&:to_sym)) : row_label_options
  Jsii::Type.check_type(@row_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "rowLabelOptions") unless @row_label_options.nil?
  @sort_configuration = sort_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::HeatMapSortConfigurationProperty.new(**sort_configuration.transform_keys(&:to_sym)) : sort_configuration
  Jsii::Type.check_type(@sort_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkhlYXRNYXBTb3J0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "sortConfiguration") unless @sort_configuration.nil?
  @tooltip = tooltip.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::TooltipOptionsProperty.new(**tooltip.transform_keys(&:to_sym)) : tooltip
  Jsii::Type.check_type(@tooltip, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRvb2x0aXBPcHRpb25zUHJvcGVydHkifV19fQ==")), "tooltip") unless @tooltip.nil?
end

Instance Attribute Details

#color_scaleAWSCDK::IResolvable, ... (readonly)

The color options (gradient color, point of divergence) in a heat map.



13583
13584
13585
# File 'quick_sight/cfn_template.rb', line 13583

def color_scale
  @color_scale
end

#column_label_optionsAWSCDK::IResolvable, ... (readonly)

The label options of the column that is displayed in a heat map.



13588
13589
13590
# File 'quick_sight/cfn_template.rb', line 13588

def column_label_options
  @column_label_options
end

#data_labelsAWSCDK::IResolvable, ... (readonly)

The options that determine if visual data labels are displayed.



13593
13594
13595
# File 'quick_sight/cfn_template.rb', line 13593

def data_labels
  @data_labels
end

#field_wellsAWSCDK::IResolvable, ... (readonly)

The field wells of the visual.



13598
13599
13600
# File 'quick_sight/cfn_template.rb', line 13598

def field_wells
  @field_wells
end

#interactionsAWSCDK::IResolvable, ... (readonly)

The general visual interactions setup for a visual.



13603
13604
13605
# File 'quick_sight/cfn_template.rb', line 13603

def interactions
  @interactions
end

#legendAWSCDK::IResolvable, ... (readonly)

The legend display setup of the visual.



13608
13609
13610
# File 'quick_sight/cfn_template.rb', line 13608

def legend
  @legend
end

#row_label_optionsAWSCDK::IResolvable, ... (readonly)

The label options of the row that is displayed in a heat map .



13613
13614
13615
# File 'quick_sight/cfn_template.rb', line 13613

def row_label_options
  @row_label_options
end

#sort_configurationAWSCDK::IResolvable, ... (readonly)

The sort configuration of a heat map.



13618
13619
13620
# File 'quick_sight/cfn_template.rb', line 13618

def sort_configuration
  @sort_configuration
end

#tooltipAWSCDK::IResolvable, ... (readonly)

The tooltip display setup of the visual.



13623
13624
13625
# File 'quick_sight/cfn_template.rb', line 13623

def tooltip
  @tooltip
end

Class Method Details

.jsii_propertiesObject



13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
# File 'quick_sight/cfn_template.rb', line 13625

def self.jsii_properties
  {
    :color_scale => "colorScale",
    :column_label_options => "columnLabelOptions",
    :data_labels => "dataLabels",
    :field_wells => "fieldWells",
    :interactions => "interactions",
    :legend => "legend",
    :row_label_options => "rowLabelOptions",
    :sort_configuration => "sortConfiguration",
    :tooltip => "tooltip",
  }
end

Instance Method Details

#to_jsiiObject



13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
# File 'quick_sight/cfn_template.rb', line 13639

def to_jsii
  result = {}
  result.merge!({
    "colorScale" => @color_scale,
    "columnLabelOptions" => @column_label_options,
    "dataLabels" => @data_labels,
    "fieldWells" => @field_wells,
    "interactions" => @interactions,
    "legend" => @legend,
    "rowLabelOptions" => @row_label_options,
    "sortConfiguration" => @sort_configuration,
    "tooltip" => @tooltip,
  })
  result.compact
end