Skip to content
v2.274.0

DataLabelOptionsProperty Struct ​

The options that determine the presentation of the data labels.

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 dataLabelOptionsProperty: quicksight.CfnAnalysis.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',
    fontFamily: 'fontFamily',
    fontSize: {
      absolute: 'absolute',
      relative: 'relative',
    },
    fontStyle: 'fontStyle',
    fontWeight: {
      name: 'name',
    },
  },
  measureLabelVisibility: 'measureLabelVisibility',
  overlap: 'overlap',
  position: 'position',
  totalsVisibility: 'totalsVisibility',
  visibility: 'visibility',
};

Properties ​

categoryLabelVisibilityoptionalstringcategory_label_visibilityoptionalstrcategoryLabelVisibilityoptionalStringCategoryLabelVisibilityoptionalstringCategoryLabelVisibilityoptional*string#
Determines the visibility of the category field labels.
dataLabelTypesoptionalIResolvable | IResolvable | CfnAnalysis.DataLabelTypeProperty[]data_label_typesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataLabelTypeProperty]]]dataLabelTypesoptionalIResolvableDataLabelTypesoptionalIResolvableDataLabelTypesoptionalinterface{}#
The option that determines the data label type.
labelColoroptionalstringlabel_coloroptionalstrlabelColoroptionalStringLabelColoroptionalstringLabelColoroptional*string#
Determines the color of the data labels.
labelContentoptionalstringlabel_contentoptionalstrlabelContentoptionalStringLabelContentoptionalstringLabelContentoptional*string#
Determines the content of the data labels.
labelFontConfigurationoptionalIResolvable | CfnAnalysis.FontConfigurationPropertylabel_font_configurationoptionaltyping.Union[IResolvable, FontConfigurationProperty]labelFontConfigurationoptionalIResolvableLabelFontConfigurationoptionalIResolvableLabelFontConfigurationoptionalinterface{}#
Determines the font configuration of the data labels.
measureLabelVisibilityoptionalstringmeasure_label_visibilityoptionalstrmeasureLabelVisibilityoptionalStringMeasureLabelVisibilityoptionalstringMeasureLabelVisibilityoptional*string#
Determines the visibility of the measure field labels.
overlapoptionalstringoverlapoptionalstroverlapoptionalStringOverlapoptionalstringOverlapoptional*string#
Determines whether overlap is enabled or disabled for the data labels.
positionoptionalstringpositionoptionalstrpositionoptionalStringPositionoptionalstringPositionoptional*string#
Determines the position of the data labels.
totalsVisibilityoptionalstringtotals_visibilityoptionalstrtotalsVisibilityoptionalStringTotalsVisibilityoptionalstringTotalsVisibilityoptional*string#
Determines the visibility of the total.
visibilityoptionalstringvisibilityoptionalstrvisibilityoptionalStringVisibilityoptionalstringVisibilityoptional*string#
Determines the visibility of the data labels.