Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.WordCloudOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.WordCloudOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.WordCloudOptionsProperty
extends software.amazon.jsii.JsiiSerializable

The word cloud options for a word cloud visual.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 WordCloudOptionsProperty wordCloudOptionsProperty = WordCloudOptionsProperty.builder()
         .cloudLayout("cloudLayout")
         .maximumStringLength(123)
         .wordCasing("wordCasing")
         .wordOrientation("wordOrientation")
         .wordPadding("wordPadding")
         .wordScaling("wordScaling")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudoptions.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboard.WordCloudOptionsProperty.Builder	A builder for CfnDashboard.WordCloudOptionsProperty
static final class	CfnDashboard.WordCloudOptionsProperty.Jsii$Proxy	An implementation for CfnDashboard.WordCloudOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.WordCloudOptionsProperty.Builder	builder()
default String	getCloudLayout()	The cloud layout options (fluid, normal) of a word cloud.
default Number	getMaximumStringLength()	The length limit of each word from 1-100.
default String	getWordCasing()	The word casing options (lower_case, existing_case) for the words in a word cloud.
default String	getWordOrientation()	The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
default String	getWordPadding()	The word padding options (none, small, medium, large) for the words in a word cloud.
default String	getWordScaling()	The word scaling options (emphasize, normal) for the words in a word cloud.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCloudLayout

@Stability(Stable)
@Nullable
default String getCloudLayout()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-wordcloudoptions-cloudlayout

getMaximumStringLength

@Stability(Stable)
@Nullable
default Number getMaximumStringLength()

The length limit of each word from 1-100.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-wordcloudoptions-maximumstringlength

getWordCasing

@Stability(Stable)
@Nullable
default String getWordCasing()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-wordcloudoptions-wordcasing

getWordOrientation

@Stability(Stable)
@Nullable
default String getWordOrientation()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-wordcloudoptions-wordorientation

getWordPadding

@Stability(Stable)
@Nullable
default String getWordPadding()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-wordcloudoptions-wordpadding

getWordScaling

@Stability(Stable)
@Nullable
default String getWordScaling()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-wordcloudoptions-wordscaling

builder

@Stability(Stable)
static CfnDashboard.WordCloudOptionsProperty.Builder builder()

Returns:

a CfnDashboard.WordCloudOptionsProperty.Builder of CfnDashboard.WordCloudOptionsProperty