Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.AxisLabelOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.AxisLabelOptionsProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.AxisLabelOptionsProperty
extends software.amazon.jsii.JsiiSerializable

The label options for a chart axis.

You must specify the field that the label is targeted to.

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.*;
 AxisLabelOptionsProperty axisLabelOptionsProperty = AxisLabelOptionsProperty.builder()
         .applyTo(AxisLabelReferenceOptionsProperty.builder()
                 .column(ColumnIdentifierProperty.builder()
                         .columnName("columnName")
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .fieldId("fieldId")
                 .build())
         .customLabel("customLabel")
         .fontConfiguration(FontConfigurationProperty.builder()
                 .fontColor("fontColor")
                 .fontDecoration("fontDecoration")
                 .fontFamily("fontFamily")
                 .fontSize(FontSizeProperty.builder()
                         .absolute("absolute")
                         .relative("relative")
                         .build())
                 .fontStyle("fontStyle")
                 .fontWeight(FontWeightProperty.builder()
                         .name("name")
                         .build())
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.AxisLabelOptionsProperty.Builder	builder()
default Object	getApplyTo()	The options that indicate which field the label belongs to.
default String	getCustomLabel()	The text for the axis label.
default Object	getFontConfiguration()	The font configuration of the axis label.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplyTo

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

The options that indicate which field the label belongs to.

Returns union: either IResolvable or CfnTemplate.AxisLabelReferenceOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabeloptions.html#cfn-quicksight-template-axislabeloptions-applyto

getCustomLabel

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

The text for the axis label.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabeloptions.html#cfn-quicksight-template-axislabeloptions-customlabel

getFontConfiguration

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

The font configuration of the axis label.

Returns union: either IResolvable or CfnTemplate.FontConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabeloptions.html#cfn-quicksight-template-axislabeloptions-fontconfiguration

builder

@Stability(Stable)
static CfnTemplate.AxisLabelOptionsProperty.Builder builder()

Returns:

a CfnTemplate.AxisLabelOptionsProperty.Builder of CfnTemplate.AxisLabelOptionsProperty