aws-cdk-lib.aws_quicksight.CfnAnalysis.ReferenceLineProperty

ReferenceLineProperty Struct

The reference line visual display options.

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 referenceLineProperty: quicksight.CfnAnalysis.ReferenceLineProperty = {
  dataConfiguration: {
    axisBinding: 'axisBinding',
    dynamicConfiguration: {
      calculation: {
        percentileAggregation: {
          percentileValue: 123,
        },
        simpleNumericalAggregation: 'simpleNumericalAggregation',
      },
      column: {
        columnName: 'columnName',

        // the properties below are optional
        dataSetIdentifier: 'dataSetIdentifier',
        topicIdentifier: 'topicIdentifier',
      },

      // the properties below are optional
      measureAggregationFunction: {
        attributeAggregationFunction: {
          simpleAttributeAggregation: 'simpleAttributeAggregation',
          valueForMultipleValues: 'valueForMultipleValues',
        },
        categoricalAggregationFunction: 'categoricalAggregationFunction',
        dateAggregationFunction: 'dateAggregationFunction',
        numericalAggregationFunction: {
          percentileAggregation: {
            percentileValue: 123,
          },
          simpleNumericalAggregation: 'simpleNumericalAggregation',
        },
      },
    },
    seriesType: 'seriesType',
    staticConfiguration: {
      value: 123,
    },
  },

  // the properties below are optional
  labelConfiguration: {
    customLabelConfiguration: {
      customLabel: 'customLabel',
    },
    fontColor: 'fontColor',
    fontConfiguration: {
      fontColor: 'fontColor',
      fontDecoration: 'fontDecoration',
      fontFamily: 'fontFamily',
      fontSize: {
        absolute: 'absolute',
        relative: 'relative',
      },
      fontStyle: 'fontStyle',
      fontWeight: {
        name: 'name',
      },
    },
    horizontalPosition: 'horizontalPosition',
    valueLabelConfiguration: {
      formatConfiguration: {
        currencyDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          numberScale: 'numberScale',
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              groupingStyle: 'groupingStyle',
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
          symbol: 'symbol',
        },
        numberDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          numberScale: 'numberScale',
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              groupingStyle: 'groupingStyle',
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
        },
        percentageDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              groupingStyle: 'groupingStyle',
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
        },
      },
      relativePosition: 'relativePosition',
    },
    verticalPosition: 'verticalPosition',
  },
  status: 'status',
  styleConfiguration: {
    color: 'color',
    pattern: 'pattern',
  },
};

Properties

dataConfigurationIResolvable | CfnAnalysis.ReferenceLineDataConfigurationPropertydata_configurationtyping.Union[IResolvable, ReferenceLineDataConfigurationProperty]dataConfigurationIResolvableDataConfigurationIResolvableDataConfigurationinterface{}required#

The data configuration of the reference line.

labelConfigurationIResolvable | CfnAnalysis.ReferenceLineLabelConfigurationPropertylabel_configurationtyping.Union[IResolvable, ReferenceLineLabelConfigurationProperty]labelConfigurationIResolvableLabelConfigurationIResolvableLabelConfigurationinterface{}#

The label configuration of the reference line.

statusstringstatusstrstatusStringStatusstringStatus*string#

The status of the reference line. Choose one of the following options:.

• ENABLE
• DISABLE

styleConfigurationIResolvable | CfnAnalysis.ReferenceLineStyleConfigurationPropertystyle_configurationtyping.Union[IResolvable, ReferenceLineStyleConfigurationProperty]styleConfigurationIResolvableStyleConfigurationIResolvableStyleConfigurationinterface{}#

The style configuration of the reference line.