Skip to content
v2.275.0

AxisLabelOptionsProperty Struct ​

The label options for a chart axis.

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

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 axisLabelOptionsProperty: quicksight.CfnAnalysis.AxisLabelOptionsProperty = {
  applyTo: {
    column: {
      columnName: 'columnName',

      // the properties below are optional
      dataSetIdentifier: 'dataSetIdentifier',
      topicIdentifier: 'topicIdentifier',
    },
    fieldId: 'fieldId',
  },
  customLabel: 'customLabel',
  fontConfiguration: {
    fontColor: 'fontColor',
    fontDecoration: 'fontDecoration',
    fontFamily: 'fontFamily',
    fontSize: {
      absolute: 'absolute',
      relative: 'relative',
    },
    fontStyle: 'fontStyle',
    fontWeight: {
      name: 'name',
    },
  },
};

Properties ​

applyTooptionalIResolvable | CfnAnalysis.AxisLabelReferenceOptionsPropertyapply_tooptionaltyping.Union[IResolvable, AxisLabelReferenceOptionsProperty]applyTooptionalIResolvableApplyTooptionalIResolvableApplyTooptionalinterface{}#
The options that indicate which field the label belongs to.
customLabeloptionalstringcustom_labeloptionalstrcustomLabeloptionalStringCustomLabeloptionalstringCustomLabeloptional*string#
The text for the axis label.
fontConfigurationoptionalIResolvable | CfnAnalysis.FontConfigurationPropertyfont_configurationoptionaltyping.Union[IResolvable, FontConfigurationProperty]fontConfigurationoptionalIResolvableFontConfigurationoptionalIResolvableFontConfigurationoptionalinterface{}#
The font configuration of the axis label.