Class: AWSCDK::QuickSight::CfnTemplate::ScatterPlotConfigurationProperty

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

Overview

The configuration of a scatter plot.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_labels: nil, field_wells: nil, interactions: nil, legend: nil, sort_configuration: nil, tooltip: nil, visual_palette: nil, x_axis_display_options: nil, x_axis_label_options: nil, y_axis_display_options: nil, y_axis_label_options: nil) ⇒ ScatterPlotConfigurationProperty

Returns a new instance of ScatterPlotConfigurationProperty.

Parameters:



23179
23180
23181
23182
23183
23184
23185
23186
23187
23188
23189
23190
23191
23192
23193
23194
23195
23196
23197
23198
23199
23200
23201
23202
 
# File 'quick_sight/cfn_template.rb', line 23179

def initialize(data_labels: nil, field_wells: nil, interactions: nil, legend: nil, sort_configuration: nil, tooltip: nil, visual_palette: nil, x_axis_display_options: nil, x_axis_label_options: nil, y_axis_display_options: nil, y_axis_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::ScatterPlotFieldWellsProperty.new(**field_wells.transform_keys(&:to_sym)) : field_wells
  Jsii::Type.check_type(@field_wells, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlNjYXR0ZXJQbG90RmllbGRXZWxsc1Byb3BlcnR5In1dfX0=")), "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?
  @sort_configuration = sort_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ScatterPlotSortConfigurationProperty.new(**sort_configuration.transform_keys(&:to_sym)) : sort_configuration
  Jsii::Type.check_type(@sort_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlNjYXR0ZXJQbG90U29ydENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "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?
  @visual_palette = visual_palette.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::VisualPaletteProperty.new(**visual_palette.transform_keys(&:to_sym)) : visual_palette
  Jsii::Type.check_type(@visual_palette, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlZpc3VhbFBhbGV0dGVQcm9wZXJ0eSJ9XX19")), "visualPalette") unless @visual_palette.nil?
  @x_axis_display_options = x_axis_display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::AxisDisplayOptionsProperty.new(**x_axis_display_options.transform_keys(&:to_sym)) : x_axis_display_options
  Jsii::Type.check_type(@x_axis_display_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkF4aXNEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "xAxisDisplayOptions") unless @x_axis_display_options.nil?
  @x_axis_label_options = x_axis_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ChartAxisLabelOptionsProperty.new(**x_axis_label_options.transform_keys(&:to_sym)) : x_axis_label_options
  Jsii::Type.check_type(@x_axis_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "xAxisLabelOptions") unless @x_axis_label_options.nil?
  @y_axis_display_options = y_axis_display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::AxisDisplayOptionsProperty.new(**y_axis_display_options.transform_keys(&:to_sym)) : y_axis_display_options
  Jsii::Type.check_type(@y_axis_display_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkF4aXNEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "yAxisDisplayOptions") unless @y_axis_display_options.nil?
  @y_axis_label_options = y_axis_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ChartAxisLabelOptionsProperty.new(**y_axis_label_options.transform_keys(&:to_sym)) : y_axis_label_options
  Jsii::Type.check_type(@y_axis_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNoYXJ0QXhpc0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "yAxisLabelOptions") unless @y_axis_label_options.nil?
end

Instance Attribute Details

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

The options that determine if visual data labels are displayed.

Returns:

See Also:



23208
23209
23210
 
# File 'quick_sight/cfn_template.rb', line 23208

def data_labels
  @data_labels
end

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

The field wells of the visual.

Returns:

See Also:



23213
23214
23215
 
# File 'quick_sight/cfn_template.rb', line 23213

def field_wells
  @field_wells
end

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

The general visual interactions setup for a visual.

Returns:

See Also:



23218
23219
23220
 
# File 'quick_sight/cfn_template.rb', line 23218

def interactions
  @interactions
end

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

The legend display setup of the visual.

Returns:

See Also:



23223
23224
23225
 
# File 'quick_sight/cfn_template.rb', line 23223

def legend
  @legend
end

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

The sort configuration of a scatter plot.

Returns:

See Also:



23228
23229
23230
 
# File 'quick_sight/cfn_template.rb', line 23228

def sort_configuration
  @sort_configuration
end

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

The legend display setup of the visual.

Returns:

See Also:



23233
23234
23235
 
# File 'quick_sight/cfn_template.rb', line 23233

def tooltip
  @tooltip
end

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

The palette (chart color) display setup of the visual.

Returns:

See Also:



23238
23239
23240
 
# File 'quick_sight/cfn_template.rb', line 23238

def visual_palette
  @visual_palette
end

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

The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.

Returns:

See Also:



23243
23244
23245
 
# File 'quick_sight/cfn_template.rb', line 23243

def x_axis_display_options
  @x_axis_display_options
end

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

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.

Returns:

See Also:



23248
23249
23250
 
# File 'quick_sight/cfn_template.rb', line 23248

def x_axis_label_options
  @x_axis_label_options
end

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

The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.

Returns:

See Also:



23253
23254
23255
 
# File 'quick_sight/cfn_template.rb', line 23253

def y_axis_display_options
  @y_axis_display_options
end

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

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.

Returns:

See Also:



23258
23259
23260
 
# File 'quick_sight/cfn_template.rb', line 23258

def y_axis_label_options
  @y_axis_label_options
end

Class Method Details

.jsii_properties ⇒ Object 



23260
23261
23262
23263
23264
23265
23266
23267
23268
23269
23270
23271
23272
23273
23274
 
# File 'quick_sight/cfn_template.rb', line 23260

def self.jsii_properties
  {
    :data_labels => "dataLabels",
    :field_wells => "fieldWells",
    :interactions => "interactions",
    :legend => "legend",
    :sort_configuration => "sortConfiguration",
    :tooltip => "tooltip",
    :visual_palette => "visualPalette",
    :x_axis_display_options => "xAxisDisplayOptions",
    :x_axis_label_options => "xAxisLabelOptions",
    :y_axis_display_options => "yAxisDisplayOptions",
    :y_axis_label_options => "yAxisLabelOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



23276
23277
23278
23279
23280
23281
23282
23283
23284
23285
23286
23287
23288
23289
23290
23291
23292
 
# File 'quick_sight/cfn_template.rb', line 23276

def to_jsii
  result = {}
  result.merge!({
    "dataLabels" => @data_labels,
    "fieldWells" => @field_wells,
    "interactions" => @interactions,
    "legend" => @legend,
    "sortConfiguration" => @sort_configuration,
    "tooltip" => @tooltip,
    "visualPalette" => @visual_palette,
    "xAxisDisplayOptions" => @x_axis_display_options,
    "xAxisLabelOptions" => @x_axis_label_options,
    "yAxisDisplayOptions" => @y_axis_display_options,
    "yAxisLabelOptions" => @y_axis_label_options,
  })
  result.compact
end