Class: AWSCDK::QuickSight::CfnDashboard::SheetImageProperty

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

Overview

An image that is located on a sheet.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sheet_image_id:, source:, actions: nil, image_content_alt_text: nil, interactions: nil, scaling: nil, tooltip: nil) ⇒ SheetImageProperty

Returns a new instance of SheetImageProperty.

Parameters:



27317
27318
27319
27320
27321
27322
27323
27324
27325
27326
27327
27328
27329
27330
27331
27332
 
# File 'quick_sight/cfn_dashboard.rb', line 27317

def initialize(sheet_image_id:, source:, actions: nil, image_content_alt_text: nil, interactions: nil, scaling: nil, tooltip: nil)
  @sheet_image_id = sheet_image_id
  Jsii::Type.check_type(@sheet_image_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sheetImageId")
  @source = source.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::SheetImageSourceProperty.new(**source.transform_keys(&:to_sym)) : source
  Jsii::Type.check_type(@source, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5TaGVldEltYWdlU291cmNlUHJvcGVydHkifV19fQ==")), "source")
  @actions = actions
  Jsii::Type.check_type(@actions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuSW1hZ2VDdXN0b21BY3Rpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "actions") unless @actions.nil?
  @image_content_alt_text = image_content_alt_text
  Jsii::Type.check_type(@image_content_alt_text, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageContentAltText") unless @image_content_alt_text.nil?
  @interactions = interactions.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ImageInteractionOptionsProperty.new(**interactions.transform_keys(&:to_sym)) : interactions
  Jsii::Type.check_type(@interactions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5JbWFnZUludGVyYWN0aW9uT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "interactions") unless @interactions.nil?
  @scaling = scaling.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::SheetImageScalingConfigurationProperty.new(**scaling.transform_keys(&:to_sym)) : scaling
  Jsii::Type.check_type(@scaling, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5TaGVldEltYWdlU2NhbGluZ0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "scaling") unless @scaling.nil?
  @tooltip = tooltip.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::SheetImageTooltipConfigurationProperty.new(**tooltip.transform_keys(&:to_sym)) : tooltip
  Jsii::Type.check_type(@tooltip, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5TaGVldEltYWdlVG9vbHRpcENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "tooltip") unless @tooltip.nil?
end

Instance Attribute Details

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

A list of custom actions that are configured for an image.

Returns:

See Also:



27348
27349
27350
 
# File 'quick_sight/cfn_dashboard.rb', line 27348

def actions
  @actions
end

#image_content_alt_text ⇒ String? (readonly)

The alt text for the image.

Returns:

  • (String, nil)

See Also:



27353
27354
27355
 
# File 'quick_sight/cfn_dashboard.rb', line 27353

def image_content_alt_text
  @image_content_alt_text
end

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

The general image interactions setup for an image.

Returns:

See Also:



27358
27359
27360
 
# File 'quick_sight/cfn_dashboard.rb', line 27358

def interactions
  @interactions
end

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

Determines how the image is scaled.

Returns:

See Also:



27363
27364
27365
 
# File 'quick_sight/cfn_dashboard.rb', line 27363

def scaling
  @scaling
end

#sheet_image_id ⇒ String (readonly)

The ID of the sheet image.

Returns:

  • (String)

See Also:



27338
27339
27340
 
# File 'quick_sight/cfn_dashboard.rb', line 27338

def sheet_image_id
  @sheet_image_id
end

#source ⇒ AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::SheetImageSourceProperty (readonly)

The source of the image.

Returns:

See Also:



27343
27344
27345
 
# File 'quick_sight/cfn_dashboard.rb', line 27343

def source
  @source
end

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

The tooltip to be shown when hovering over the image.

Returns:

See Also:



27368
27369
27370
 
# File 'quick_sight/cfn_dashboard.rb', line 27368

def tooltip
  @tooltip
end

Class Method Details

.jsii_properties ⇒ Object 



27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
 
# File 'quick_sight/cfn_dashboard.rb', line 27370

def self.jsii_properties
  {
    :sheet_image_id => "sheetImageId",
    :source => "source",
    :actions => "actions",
    :image_content_alt_text => "imageContentAltText",
    :interactions => "interactions",
    :scaling => "scaling",
    :tooltip => "tooltip",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



27382
27383
27384
27385
27386
27387
27388
27389
27390
27391
27392
27393
27394
 
# File 'quick_sight/cfn_dashboard.rb', line 27382

def to_jsii
  result = {}
  result.merge!({
    "sheetImageId" => @sheet_image_id,
    "source" => @source,
    "actions" => @actions,
    "imageContentAltText" => @image_content_alt_text,
    "interactions" => @interactions,
    "scaling" => @scaling,
    "tooltip" => @tooltip,
  })
  result.compact
end