interface BoxPlotFieldWellsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnAnalysis.BoxPlotFieldWellsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_BoxPlotFieldWellsProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnAnalysis.BoxPlotFieldWellsProperty`
Python	`aws_cdk.aws_quicksight.CfnAnalysis.BoxPlotFieldWellsProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnAnalysis` » `BoxPlotFieldWellsProperty`
The field wells of a BoxPlotVisual .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
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 boxPlotFieldWellsProperty: quicksight.CfnAnalysis.BoxPlotFieldWellsProperty = {
  boxPlotAggregatedFieldWells: {
    groupBy: [{
      categoricalDimensionField: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        fieldId: 'fieldId',

        // the properties below are optional
        formatConfiguration: {
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          numericFormatConfiguration: {
            currencyDisplayFormatConfiguration: {
              decimalPlacesConfiguration: {
                decimalPlaces: 123,
              },
              negativeValueConfiguration: {
                displayMode: 'displayMode',
              },
              nullValueFormatConfiguration: {
                nullString: 'nullString',
              },
              numberScale: 'numberScale',
              prefix: 'prefix',
              separatorConfiguration: {
                decimalSeparator: 'decimalSeparator',
                thousandsSeparator: {
                  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: {
                  symbol: 'symbol',
                  visibility: 'visibility',
                },
              },
              suffix: 'suffix',
            },
            percentageDisplayFormatConfiguration: {
              decimalPlacesConfiguration: {
                decimalPlaces: 123,
              },
              negativeValueConfiguration: {
                displayMode: 'displayMode',
              },
              nullValueFormatConfiguration: {
                nullString: 'nullString',
              },
              prefix: 'prefix',
              separatorConfiguration: {
                decimalSeparator: 'decimalSeparator',
                thousandsSeparator: {
                  symbol: 'symbol',
                  visibility: 'visibility',
                },
              },
              suffix: 'suffix',
            },
          },
        },
        hierarchyId: 'hierarchyId',
      },
      dateDimensionField: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        fieldId: 'fieldId',

        // the properties below are optional
        dateGranularity: 'dateGranularity',
        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: {
                  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: {
                  symbol: 'symbol',
                  visibility: 'visibility',
                },
              },
              suffix: 'suffix',
            },
            percentageDisplayFormatConfiguration: {
              decimalPlacesConfiguration: {
                decimalPlaces: 123,
              },
              negativeValueConfiguration: {
                displayMode: 'displayMode',
              },
              nullValueFormatConfiguration: {
                nullString: 'nullString',
              },
              prefix: 'prefix',
              separatorConfiguration: {
                decimalSeparator: 'decimalSeparator',
                thousandsSeparator: {
                  symbol: 'symbol',
                  visibility: 'visibility',
                },
              },
              suffix: 'suffix',
            },
          },
        },
        hierarchyId: 'hierarchyId',
      },
      numericalDimensionField: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        fieldId: 'fieldId',

        // the properties below are optional
        formatConfiguration: {
          formatConfiguration: {
            currencyDisplayFormatConfiguration: {
              decimalPlacesConfiguration: {
                decimalPlaces: 123,
              },
              negativeValueConfiguration: {
                displayMode: 'displayMode',
              },
              nullValueFormatConfiguration: {
                nullString: 'nullString',
              },
              numberScale: 'numberScale',
              prefix: 'prefix',
              separatorConfiguration: {
                decimalSeparator: 'decimalSeparator',
                thousandsSeparator: {
                  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: {
                  symbol: 'symbol',
                  visibility: 'visibility',
                },
              },
              suffix: 'suffix',
            },
            percentageDisplayFormatConfiguration: {
              decimalPlacesConfiguration: {
                decimalPlaces: 123,
              },
              negativeValueConfiguration: {
                displayMode: 'displayMode',
              },
              nullValueFormatConfiguration: {
                nullString: 'nullString',
              },
              prefix: 'prefix',
              separatorConfiguration: {
                decimalSeparator: 'decimalSeparator',
                thousandsSeparator: {
                  symbol: 'symbol',
                  visibility: 'visibility',
                },
              },
              suffix: 'suffix',
            },
          },
        },
        hierarchyId: 'hierarchyId',
      },
    }],
    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: {
                  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: {
                  symbol: 'symbol',
                  visibility: 'visibility',
                },
              },
              suffix: 'suffix',
            },
            percentageDisplayFormatConfiguration: {
              decimalPlacesConfiguration: {
                decimalPlaces: 123,
              },
              negativeValueConfiguration: {
                displayMode: 'displayMode',
              },
              nullValueFormatConfiguration: {
                nullString: 'nullString',
              },
              prefix: 'prefix',
              separatorConfiguration: {
                decimalSeparator: 'decimalSeparator',
                thousandsSeparator: {
                  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: {
                  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: {
                  symbol: 'symbol',
                  visibility: 'visibility',
                },
              },
              suffix: 'suffix',
            },
            percentageDisplayFormatConfiguration: {
              decimalPlacesConfiguration: {
                decimalPlaces: 123,
              },
              negativeValueConfiguration: {
                displayMode: 'displayMode',
              },
              nullValueFormatConfiguration: {
                nullString: 'nullString',
              },
              prefix: 'prefix',
              separatorConfiguration: {
                decimalSeparator: 'decimalSeparator',
                thousandsSeparator: {
                  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: {
                  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: {
                  symbol: 'symbol',
                  visibility: 'visibility',
                },
              },
              suffix: 'suffix',
            },
            percentageDisplayFormatConfiguration: {
              decimalPlacesConfiguration: {
                decimalPlaces: 123,
              },
              negativeValueConfiguration: {
                displayMode: 'displayMode',
              },
              nullValueFormatConfiguration: {
                nullString: 'nullString',
              },
              prefix: 'prefix',
              separatorConfiguration: {
                decimalSeparator: 'decimalSeparator',
                thousandsSeparator: {
                  symbol: 'symbol',
                  visibility: 'visibility',
                },
              },
              suffix: 'suffix',
            },
          },
        },
      },
    }],
  },
};
Properties

Name	Type	Description
boxPlotAggregatedFieldWells?	`IResolvable` `\|` `BoxPlotAggregatedFieldWellsProperty`	The aggregated field wells of a box plot.
boxPlotAggregatedFieldWells?

Type: IResolvable | BoxPlotAggregatedFieldWellsProperty (optional)
The aggregated field wells of a box plot.