interface HistogramFieldWellsProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnDashboard.HistogramFieldWellsProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_HistogramFieldWellsProperty
Java	software.amazon.awscdk.services.quicksight.CfnDashboard.HistogramFieldWellsProperty
Python	aws_cdk.aws_quicksight.CfnDashboard.HistogramFieldWellsProperty
TypeScript	aws-cdk-lib » aws_quicksight » CfnDashboard » HistogramFieldWellsProperty

The field well configuration of a histogram.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramfieldwells.html

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 histogramFieldWellsProperty: quicksight.CfnDashboard.HistogramFieldWellsProperty = {
  histogramAggregatedFieldWells: {
    values: [{
      calculatedMeasureField: {
        expression: 'expression',
        fieldId: 'fieldId',
      },
      categoricalMeasureField: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        fieldId: 'fieldId',

        // the properties below are optional
        aggregationFunction: 'aggregationFunction',
        formatConfiguration: {
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          numericFormatConfiguration: {
            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',
            },
          },
        },
      },
      dateMeasureField: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        fieldId: 'fieldId',

        // the properties below are optional
        aggregationFunction: 'aggregationFunction',
        formatConfiguration: {
          dateTimeFormat: 'dateTimeFormat',
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          numericFormatConfiguration: {
            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',
            },
          },
        },
      },
      numericalMeasureField: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        fieldId: 'fieldId',

        // the properties below are optional
        aggregationFunction: {
          percentileAggregation: {
            percentileValue: 123,
          },
          simpleNumericalAggregation: 'simpleNumericalAggregation',
        },
        formatConfiguration: {
          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',
            },
          },
        },
      },
    }],
  },
};

Properties

Name	Type	Description
histogramAggregatedFieldWells?	IResolvable | HistogramAggregatedFieldWellsProperty	The field well configuration of a histogram.

---

histogramAggregatedFieldWells?

Type: IResolvable | HistogramAggregatedFieldWellsProperty (optional)

The field well configuration of a histogram.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramfieldwells.html#cfn-quicksight-dashboard-histogramfieldwells-histogramaggregatedfieldwells