interface DataLabelOptionsProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnDashboard.DataLabelOptionsProperty
Java	software.amazon.awscdk.services.quicksight.CfnDashboard.DataLabelOptionsProperty
Python	aws_cdk.aws_quicksight.CfnDashboard.DataLabelOptionsProperty
TypeScript	@aws-cdk/aws-quicksight » CfnDashboard » DataLabelOptionsProperty

The options that determine the presentation of the data labels.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const dataLabelOptionsProperty: quicksight.CfnDashboard.DataLabelOptionsProperty = {
  categoryLabelVisibility: 'categoryLabelVisibility',
  dataLabelTypes: [{
    dataPathLabelType: {
      fieldId: 'fieldId',
      fieldValue: 'fieldValue',
      visibility: 'visibility',
    },
    fieldLabelType: {
      fieldId: 'fieldId',
      visibility: 'visibility',
    },
    maximumLabelType: {
      visibility: 'visibility',
    },
    minimumLabelType: {
      visibility: 'visibility',
    },
    rangeEndsLabelType: {
      visibility: 'visibility',
    },
  }],
  labelColor: 'labelColor',
  labelContent: 'labelContent',
  labelFontConfiguration: {
    fontColor: 'fontColor',
    fontDecoration: 'fontDecoration',
    fontSize: {
      relative: 'relative',
    },
    fontStyle: 'fontStyle',
    fontWeight: {
      name: 'name',
    },
  },
  measureLabelVisibility: 'measureLabelVisibility',
  overlap: 'overlap',
  position: 'position',
  visibility: 'visibility',
};

Properties

Name	Type	Description
categoryLabelVisibility?	string	Determines the visibility of the category field labels.
dataLabelTypes?	IResolvable | IResolvable | DataLabelTypeProperty[]	The option that determines the data label type.
labelColor?	string	Determines the color of the data labels.
labelContent?	string	Determines the content of the data labels.
labelFontConfiguration?	IResolvable | FontConfigurationProperty	Determines the font configuration of the data labels.
measureLabelVisibility?	string	Determines the visibility of the measure field labels.
overlap?	string	Determines whether overlap is enabled or disabled for the data labels.
position?	string	Determines the position of the data labels.
visibility?	string	Determines the visibility of the data labels.

---

categoryLabelVisibility?

Type: string (optional)

Determines the visibility of the category field labels.

---

dataLabelTypes?

Type: IResolvable | IResolvable | DataLabelTypeProperty[] (optional)

The option that determines the data label type.

---

labelColor?

Type: string (optional)

Determines the color of the data labels.

---

labelContent?

Type: string (optional)

Determines the content of the data labels.

---

labelFontConfiguration?

Type: IResolvable | FontConfigurationProperty (optional)

Determines the font configuration of the data labels.

---

measureLabelVisibility?

Type: string (optional)

Determines the visibility of the measure field labels.

---

overlap?

Type: string (optional)

Determines whether overlap is enabled or disabled for the data labels.

---

position?

Type: string (optional)

Determines the position of the data labels.

---

visibility?

Type: string (optional)

Determines the visibility of the data labels.