aws-cdk-lib.aws_quicksight.CfnAnalysis.AxisLabelOptionsProperty

interface AxisLabelOptionsProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnAnalysis.AxisLabelOptionsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_AxisLabelOptionsProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnAnalysis.AxisLabelOptionsProperty
Pythonaws_cdk.aws_quicksight.CfnAnalysis.AxisLabelOptionsProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnAnalysis » 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.CfnAnalysis.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

NameTypeDescription
applyTo?IResolvable | AxisLabelReferenceOptionsPropertyThe options that indicate which field the label belongs to.
customLabel?stringThe text for the axis label.
fontConfiguration?IResolvable | FontConfigurationPropertyThe 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.