aws-cdk-lib.aws_quicksight.CfnDashboard.DataLabelOptionsProperty

interface DataLabelOptionsProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnDashboard.DataLabelOptionsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_DataLabelOptionsProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnDashboard.DataLabelOptionsProperty
Pythonaws_cdk.aws_quicksight.CfnDashboard.DataLabelOptionsProperty
TypeScript aws-cdk-lib » 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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
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',
  totalsVisibility: 'totalsVisibility',
  visibility: 'visibility',
};

Properties

NameTypeDescription
categoryLabelVisibility?stringDetermines the visibility of the category field labels.
dataLabelTypes?IResolvable | IResolvable | DataLabelTypeProperty[]The option that determines the data label type.
labelColor?stringDetermines the color of the data labels.
labelContent?stringDetermines the content of the data labels.
labelFontConfiguration?IResolvable | FontConfigurationPropertyDetermines the font configuration of the data labels.
measureLabelVisibility?stringDetermines the visibility of the measure field labels.
overlap?stringDetermines whether overlap is enabled or disabled for the data labels.
position?stringDetermines the position of the data labels.
totalsVisibility?stringDetermines the visibility of the total.
visibility?stringDetermines 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.


totalsVisibility?

Type: string (optional)

Determines the visibility of the total.


visibility?

Type: string (optional)

Determines the visibility of the data labels.