Skip to content
v2.278.0

WordCloudOptionsProperty Struct ​

The word cloud options for a word cloud visual.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const wordCloudOptionsProperty: quicksight.CfnTemplate.WordCloudOptionsProperty = {
  cloudLayout: 'cloudLayout',
  maximumStringLength: 123,
  wordCasing: 'wordCasing',
  wordOrientation: 'wordOrientation',
  wordPadding: 'wordPadding',
  wordScaling: 'wordScaling',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

word_cloud_options_property = quicksight.CfnTemplate.WordCloudOptionsProperty(
    cloud_layout="cloudLayout",
    maximum_string_length=123,
    word_casing="wordCasing",
    word_orientation="wordOrientation",
    word_padding="wordPadding",
    word_scaling="wordScaling"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var wordCloudOptionsProperty = new WordCloudOptionsProperty {
    CloudLayout = "cloudLayout",
    MaximumStringLength = 123,
    WordCasing = "wordCasing",
    WordOrientation = "wordOrientation",
    WordPadding = "wordPadding",
    WordScaling = "wordScaling"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

wordCloudOptionsProperty := &WordCloudOptionsProperty{
	CloudLayout: jsii.String("cloudLayout"),
	MaximumStringLength: jsii.Number(123),
	WordCasing: jsii.String("wordCasing"),
	WordOrientation: jsii.String("wordOrientation"),
	WordPadding: jsii.String("wordPadding"),
	WordScaling: jsii.String("wordScaling"),
}

Properties ​

cloudLayoutoptionalstringcloud_layoutoptionalstrcloudLayoutoptionalStringCloudLayoutoptionalstringCloudLayoutoptional*string #
The cloud layout options (fluid, normal) of a word cloud.
maximumStringLengthoptionalnumbermaximum_string_lengthoptionalint | floatmaximumStringLengthoptionalNumberMaximumStringLengthoptionaldoubleMaximumStringLengthoptional*float64 #
The length limit of each word from 1-100.
wordCasingoptionalstringword_casingoptionalstrwordCasingoptionalStringWordCasingoptionalstringWordCasingoptional*string #
The word casing options (lower_case, existing_case) for the words in a word cloud.
wordOrientationoptionalstringword_orientationoptionalstrwordOrientationoptionalStringWordOrientationoptionalstringWordOrientationoptional*string #
The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
wordPaddingoptionalstringword_paddingoptionalstrwordPaddingoptionalStringWordPaddingoptionalstringWordPaddingoptional*string #
The word padding options (none, small, medium, large) for the words in a word cloud.
wordScalingoptionalstringword_scalingoptionalstrwordScalingoptionalStringWordScalingoptionalstringWordScalingoptional*string #
The word scaling options (emphasize, normal) for the words in a word cloud.