interface SankeyDiagramChartConfigurationProperty

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

The configuration of a sankey diagram.

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 sankeyDiagramChartConfigurationProperty: quicksight.CfnAnalysis.SankeyDiagramChartConfigurationProperty = {
  dataLabels: {
    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',
      fontSize: {
        relative: 'relative',
      },
      fontStyle: 'fontStyle',
      fontWeight: {
        name: 'name',
      },
    },
    measureLabelVisibility: 'measureLabelVisibility',
    overlap: 'overlap',
    position: 'position',
    visibility: 'visibility',
  },
  fieldWells: {
    sankeyDiagramAggregatedFieldWells: {
      destination: [{
        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',
        },
      }],
      source: [{
        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',
        },
      }],
      weight: [{
        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: {
    destinationItemsLimit: {
      itemsLimit: 123,
      otherCategories: 'otherCategories',
    },
    sourceItemsLimit: {
      itemsLimit: 123,
      otherCategories: 'otherCategories',
    },
    weightSort: [{
      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',
      },
    }],
  },
};

Properties

Name	Type	Description
dataLabels?	IResolvable | DataLabelOptionsProperty	The data label configuration of a sankey diagram.
fieldWells?	IResolvable | SankeyDiagramFieldWellsProperty	The field well configuration of a sankey diagram.
sortConfiguration?	IResolvable | SankeyDiagramSortConfigurationProperty	The sort configuration of a sankey diagram.

---

dataLabels?

Type: IResolvable | DataLabelOptionsProperty (optional)

The data label configuration of a sankey diagram.

---

fieldWells?

Type: IResolvable | SankeyDiagramFieldWellsProperty (optional)

The field well configuration of a sankey diagram.

---

sortConfiguration?

Type: IResolvable | SankeyDiagramSortConfigurationProperty (optional)

The sort configuration of a sankey diagram.