Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.LegendOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.LegendOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

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

The options for the legend setup of a 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.*;
 LegendOptionsProperty legendOptionsProperty = LegendOptionsProperty.builder()
         .height("height")
         .position("position")
         .title(LabelOptionsProperty.builder()
                 .customLabel("customLabel")
                 .fontConfiguration(FontConfigurationProperty.builder()
                         .fontColor("fontColor")
                         .fontDecoration("fontDecoration")
                         .fontSize(FontSizeProperty.builder()
                                 .relative("relative")
                                 .build())
                         .fontStyle("fontStyle")
                         .fontWeight(FontWeightProperty.builder()
                                 .name("name")
                                 .build())
                         .build())
                 .visibility("visibility")
                 .build())
         .visibility("visibility")
         .width("width")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.LegendOptionsProperty.Builder	builder()
default String	getHeight()	The height of the legend.
default String	getPosition()	The positions for the legend.
default Object	getTitle()	The custom title for the legend.
default String	getVisibility()	Determines whether or not the legend is visible.
default String	getWidth()	The width of the legend.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHeight

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

The height of the legend.

If this value is omitted, a default height is used when rendering.

See Also:

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

getPosition

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

The positions for the legend. Choose one of the following options:.

• AUTO
• RIGHT
• BOTTOM
• LEFT

See Also:

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

getTitle

@Stability(Stable)
@Nullable
default Object getTitle()

The custom title for the legend.

See Also:

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

getVisibility

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

Determines whether or not the legend is visible.

See Also:

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

getWidth

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

The width of the legend.

If this value is omitted, a default width is used when rendering.

See Also:

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

builder

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

Returns:

a CfnDashboard.LegendOptionsProperty.Builder of CfnDashboard.LegendOptionsProperty