Interface SankeyChartDataOptions Beta

Configuration for how to query aggregate data and assign data to a Sankey chart.

Example

<SankeyChart
  dataSet={dataSource}
  dataOptions={{
    category: [DM.Commerce.Gender, DM.Commerce.AgeRange],
    value: measureFactory.sum(DM.Commerce.Revenue),
  }}
/>

Properties

category

category: (CalculatedColumn | Column | StyledColumn)[]

Columns (or attributes) representing the nodes in each stage of the flow. Must contain at least 2 items to define source and target nodes. When more than 2 items are provided the chart displays multi-stage flows.

seriesToColorMap

seriesToColorMap?: MultiColumnValueToColorMap | ValueToColorMap

Optional mapping of node names to colors.

value

value: CalculatedMeasureColumn | MeasureColumn | StyledMeasureColumn

Measure column whose aggregated values determine the flow weight between nodes. Use a styled measure column to apply number formatting.