Class: AWSCDK::QuickSight::CfnAnalysis::WordCloudOptionsProperty

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

Overview

The word cloud options for a word cloud visual.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cloud_layout: nil, maximum_string_length: nil, word_casing: nil, word_orientation: nil, word_padding: nil, word_scaling: nil) ⇒ WordCloudOptionsProperty

Returns a new instance of WordCloudOptionsProperty.

Parameters:

  • cloud_layout (String, nil) (defaults to: nil) —

    The cloud layout options (fluid, normal) of a word cloud.

  • maximum_string_length (Numeric, nil) (defaults to: nil) —

    The length limit of each word from 1-100.

  • word_casing (String, nil) (defaults to: nil) —

    The word casing options (lower_case, existing_case) for the words in a word cloud.

  • word_orientation (String, nil) (defaults to: nil) —

    The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

  • word_padding (String, nil) (defaults to: nil) —

    The word padding options (none, small, medium, large) for the words in a word cloud.

  • word_scaling (String, nil) (defaults to: nil) —

    The word scaling options (emphasize, normal) for the words in a word cloud.



32347
32348
32349
32350
32351
32352
32353
32354
32355
32356
32357
32358
32359
32360
 
# File 'quick_sight/cfn_analysis.rb', line 32347

def initialize(cloud_layout: nil, maximum_string_length: nil, word_casing: nil, word_orientation: nil, word_padding: nil, word_scaling: nil)
  @cloud_layout = cloud_layout
  Jsii::Type.check_type(@cloud_layout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cloudLayout") unless @cloud_layout.nil?
  @maximum_string_length = maximum_string_length
  Jsii::Type.check_type(@maximum_string_length, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumStringLength") unless @maximum_string_length.nil?
  @word_casing = word_casing
  Jsii::Type.check_type(@word_casing, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "wordCasing") unless @word_casing.nil?
  @word_orientation = word_orientation
  Jsii::Type.check_type(@word_orientation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "wordOrientation") unless @word_orientation.nil?
  @word_padding = word_padding
  Jsii::Type.check_type(@word_padding, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "wordPadding") unless @word_padding.nil?
  @word_scaling = word_scaling
  Jsii::Type.check_type(@word_scaling, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "wordScaling") unless @word_scaling.nil?
end

Instance Attribute Details

#cloud_layout ⇒ String? (readonly)

The cloud layout options (fluid, normal) of a word cloud.

Returns:

  • (String, nil)

See Also:



32366
32367
32368
 
# File 'quick_sight/cfn_analysis.rb', line 32366

def cloud_layout
  @cloud_layout
end

#maximum_string_length ⇒ Numeric? (readonly)

The length limit of each word from 1-100.

Returns:

  • (Numeric, nil)

See Also:



32371
32372
32373
 
# File 'quick_sight/cfn_analysis.rb', line 32371

def maximum_string_length
  @maximum_string_length
end

#word_casing ⇒ String? (readonly)

The word casing options (lower_case, existing_case) for the words in a word cloud.

Returns:

  • (String, nil)

See Also:



32376
32377
32378
 
# File 'quick_sight/cfn_analysis.rb', line 32376

def word_casing
  @word_casing
end

#word_orientation ⇒ String? (readonly)

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

Returns:

  • (String, nil)

See Also:



32381
32382
32383
 
# File 'quick_sight/cfn_analysis.rb', line 32381

def word_orientation
  @word_orientation
end

#word_padding ⇒ String? (readonly)

The word padding options (none, small, medium, large) for the words in a word cloud.

Returns:

  • (String, nil)

See Also:



32386
32387
32388
 
# File 'quick_sight/cfn_analysis.rb', line 32386

def word_padding
  @word_padding
end

#word_scaling ⇒ String? (readonly)

The word scaling options (emphasize, normal) for the words in a word cloud.

Returns:

  • (String, nil)

See Also:



32391
32392
32393
 
# File 'quick_sight/cfn_analysis.rb', line 32391

def word_scaling
  @word_scaling
end

Class Method Details

.jsii_properties ⇒ Object 



32393
32394
32395
32396
32397
32398
32399
32400
32401
32402
 
# File 'quick_sight/cfn_analysis.rb', line 32393

def self.jsii_properties
  {
    :cloud_layout => "cloudLayout",
    :maximum_string_length => "maximumStringLength",
    :word_casing => "wordCasing",
    :word_orientation => "wordOrientation",
    :word_padding => "wordPadding",
    :word_scaling => "wordScaling",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



32404
32405
32406
32407
32408
32409
32410
32411
32412
32413
32414
32415
 
# File 'quick_sight/cfn_analysis.rb', line 32404

def to_jsii
  result = {}
  result.merge!({
    "cloudLayout" => @cloud_layout,
    "maximumStringLength" => @maximum_string_length,
    "wordCasing" => @word_casing,
    "wordOrientation" => @word_orientation,
    "wordPadding" => @word_padding,
    "wordScaling" => @word_scaling,
  })
  result.compact
end