interface AxisLabelOptionsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDashboard.AxisLabelOptionsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_AxisLabelOptionsProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnDashboard.AxisLabelOptionsProperty`
Python	`aws_cdk.aws_quicksight.CfnDashboard.AxisLabelOptionsProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnDashboard` » `AxisLabelOptionsProperty`

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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const axisLabelOptionsProperty: quicksight.CfnDashboard.AxisLabelOptionsProperty = {
  applyTo: {
    column: {
      columnName: 'columnName',
      dataSetIdentifier: 'dataSetIdentifier',
    },
    fieldId: 'fieldId',
  },
  customLabel: 'customLabel',
  fontConfiguration: {
    fontColor: 'fontColor',
    fontDecoration: 'fontDecoration',
    fontSize: {
      relative: 'relative',
    },
    fontStyle: 'fontStyle',
    fontWeight: {
      name: 'name',
    },
  },
};

Properties

Name	Type	Description
applyTo?	`IResolvable` `\|` `AxisLabelReferenceOptionsProperty`	The options that indicate which field the label belongs to.
customLabel?	`string`	The text for the axis label.
fontConfiguration?	`IResolvable` `\|` `FontConfigurationProperty`	The font configuration of the axis label.

applyTo?

Type: IResolvable | AxisLabelReferenceOptionsProperty (optional)

The options that indicate which field the label belongs to.

customLabel?

Type: string (optional)

The text for the axis label.

fontConfiguration?

Type: IResolvable | FontConfigurationProperty (optional)

The font configuration of the axis label.