Skip to content
v2.274.0

ChartAxisLabelOptionsProperty Struct ​

The label options for an axis on a chart.

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 chartAxisLabelOptionsProperty: quicksight.CfnTemplate.ChartAxisLabelOptionsProperty = {
  axisLabelOptions: [{
    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',
      },
    },
  }],
  sortIconVisibility: 'sortIconVisibility',
  visibility: 'visibility',
};

Properties ​

axisLabelOptionsoptionalIResolvable | IResolvable | CfnTemplate.AxisLabelOptionsProperty[]axis_label_optionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AxisLabelOptionsProperty]]]axisLabelOptionsoptionalIResolvableAxisLabelOptionsoptionalIResolvableAxisLabelOptionsoptionalinterface{}#
The label options for a chart axis.
sortIconVisibilityoptionalstringsort_icon_visibilityoptionalstrsortIconVisibilityoptionalStringSortIconVisibilityoptionalstringSortIconVisibilityoptional*string#
The visibility configuration of the sort icon on a chart's axis label.
visibilityoptionalstringvisibilityoptionalstrvisibilityoptionalStringVisibilityoptionalstringVisibilityoptional*string#
The visibility of an axis label on a chart. Choose one of the following options:.
  • VISIBLE : Shows the axis.
  • HIDDEN : Hides the axis.