interface FunnelChartConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDashboard.FunnelChartConfigurationProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnDashboard.FunnelChartConfigurationProperty`
Python	`aws_cdk.aws_quicksight.CfnDashboard.FunnelChartConfigurationProperty`
TypeScript	`@aws-cdk/aws-quicksight` » `CfnDashboard` » `FunnelChartConfigurationProperty`

The configuration of a FunnelChartVisual .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const funnelChartConfigurationProperty: quicksight.CfnDashboard.FunnelChartConfigurationProperty = {
  categoryLabelOptions: {
    axisLabelOptions: [{
      applyTo: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        fieldId: 'fieldId',
      },
      customLabel: 'customLabel',
      fontConfiguration: {
        fontColor: 'fontColor',
        fontDecoration: 'fontDecoration',
        fontSize: {
          relative: 'relative',
        },
        fontStyle: 'fontStyle',
        fontWeight: {
          name: 'name',
        },
      },
    }],
    sortIconVisibility: 'sortIconVisibility',
    visibility: 'visibility',
  },
  dataLabelOptions: {
    categoryLabelVisibility: 'categoryLabelVisibility',
    labelColor: 'labelColor',
    labelFontConfiguration: {
      fontColor: 'fontColor',
      fontDecoration: 'fontDecoration',
      fontSize: {
        relative: 'relative',
      },
      fontStyle: 'fontStyle',
      fontWeight: {
        name: 'name',
      },
    },
    measureDataLabelStyle: 'measureDataLabelStyle',
    measureLabelVisibility: 'measureLabelVisibility',
    position: 'position',
    visibility: 'visibility',
  },
  fieldWells: {
    funnelChartAggregatedFieldWells: {
      category: [{
        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',
              },
            },
          },
        },
      }],
    },
  },
  sortConfiguration: {
    categoryItemsLimit: {
      itemsLimit: 123,
      otherCategories: 'otherCategories',
    },
    categorySort: [{
      columnSort: {
        direction: 'direction',
        sortBy: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },

        // the properties below are optional
        aggregationFunction: {
          categoricalAggregationFunction: 'categoricalAggregationFunction',
          dateAggregationFunction: 'dateAggregationFunction',
          numericalAggregationFunction: {
            percentileAggregation: {
              percentileValue: 123,
            },
            simpleNumericalAggregation: 'simpleNumericalAggregation',
          },
        },
      },
      fieldSort: {
        direction: 'direction',
        fieldId: 'fieldId',
      },
    }],
  },
  tooltip: {
    fieldBasedTooltip: {
      aggregationVisibility: 'aggregationVisibility',
      tooltipFields: [{
        columnTooltipItem: {
          column: {
            columnName: 'columnName',
            dataSetIdentifier: 'dataSetIdentifier',
          },

          // the properties below are optional
          aggregation: {
            categoricalAggregationFunction: 'categoricalAggregationFunction',
            dateAggregationFunction: 'dateAggregationFunction',
            numericalAggregationFunction: {
              percentileAggregation: {
                percentileValue: 123,
              },
              simpleNumericalAggregation: 'simpleNumericalAggregation',
            },
          },
          label: 'label',
          visibility: 'visibility',
        },
        fieldTooltipItem: {
          fieldId: 'fieldId',

          // the properties below are optional
          label: 'label',
          visibility: 'visibility',
        },
      }],
      tooltipTitleType: 'tooltipTitleType',
    },
    selectedTooltipType: 'selectedTooltipType',
    tooltipVisibility: 'tooltipVisibility',
  },
  valueLabelOptions: {
    axisLabelOptions: [{
      applyTo: {
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        fieldId: 'fieldId',
      },
      customLabel: 'customLabel',
      fontConfiguration: {
        fontColor: 'fontColor',
        fontDecoration: 'fontDecoration',
        fontSize: {
          relative: 'relative',
        },
        fontStyle: 'fontStyle',
        fontWeight: {
          name: 'name',
        },
      },
    }],
    sortIconVisibility: 'sortIconVisibility',
    visibility: 'visibility',
  },
  visualPalette: {
    chartColor: 'chartColor',
    colorMap: [{
      color: 'color',
      element: {
        fieldId: 'fieldId',
        fieldValue: 'fieldValue',
      },

      // the properties below are optional
      timeGranularity: 'timeGranularity',
    }],
  },
};

Properties

Name	Type	Description
categoryLabelOptions?	`IResolvable` `\|` `ChartAxisLabelOptionsProperty`	The label options of the categories that are displayed in a `FunnelChartVisual` .
dataLabelOptions?	`IResolvable` `\|` `FunnelChartDataLabelOptionsProperty`	The options that determine the presentation of the data labels.
fieldWells?	`IResolvable` `\|` `FunnelChartFieldWellsProperty`	The field well configuration of a `FunnelChartVisual` .
sortConfiguration?	`IResolvable` `\|` `FunnelChartSortConfigurationProperty`	The sort configuration of a `FunnelChartVisual` .
tooltip?	`IResolvable` `\|` `TooltipOptionsProperty`	The tooltip configuration of a `FunnelChartVisual` .
valueLabelOptions?	`IResolvable` `\|` `ChartAxisLabelOptionsProperty`	The label options for the values that are displayed in a `FunnelChartVisual` .
visualPalette?	`IResolvable` `\|` `VisualPaletteProperty`	The visual palette configuration of a `FunnelChartVisual` .