aws-cdk-lib.aws_quicksight.CfnTemplate.DataLabelOptionsProperty

DataLabelOptionsProperty Struct

The options that determine the presentation of the data labels.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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.CfnTemplate.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

categoryLabelVisibilitystringcategory_label_visibilitystrcategoryLabelVisibilityStringCategoryLabelVisibilitystringCategoryLabelVisibility*string#

Determines the visibility of the category field labels.

dataLabelTypesIResolvable | IResolvable | CfnTemplate.DataLabelTypeProperty[]data_label_typestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataLabelTypeProperty]]]dataLabelTypesIResolvableDataLabelTypesIResolvableDataLabelTypesinterface{}#

The option that determines the data label type.

labelColorstringlabel_colorstrlabelColorStringLabelColorstringLabelColor*string#

Determines the color of the data labels.

labelContentstringlabel_contentstrlabelContentStringLabelContentstringLabelContent*string#

Determines the content of the data labels.

labelFontConfigurationIResolvable | CfnTemplate.FontConfigurationPropertylabel_font_configurationtyping.Union[IResolvable, FontConfigurationProperty]labelFontConfigurationIResolvableLabelFontConfigurationIResolvableLabelFontConfigurationinterface{}#

Determines the font configuration of the data labels.

measureLabelVisibilitystringmeasure_label_visibilitystrmeasureLabelVisibilityStringMeasureLabelVisibilitystringMeasureLabelVisibility*string#

Determines the visibility of the measure field labels.

overlapstringoverlapstroverlapStringOverlapstringOverlap*string#

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

positionstringpositionstrpositionStringPositionstringPosition*string#

Determines the position of the data labels.

totalsVisibilitystringtotals_visibilitystrtotalsVisibilityStringTotalsVisibilitystringTotalsVisibility*string#

Determines the visibility of the total.

visibilitystringvisibilitystrvisibilityStringVisibilitystringVisibility*string#

Determines the visibility of the data labels.