Configure Sankey Chart

Overview

This article helps you configure Sankey chart using the components available in the WebApp Builder. This chart is ideal for visualizing flow and movement between stages, tracking conversion funnels and user journeys, or displaying resource allocation and distribution pathways where link width represents quantity.

Prerequisites

Review the recommendations provided to design/create a chart dataset.
Ensure that a Dataset is created for the appropriate chart type and purpose, using the required fields.
When cleansing or enriching data, users may want to visualize their work with charts. In this case, create a Grid or Form container on a construct page and use the same dataset to bind data between the Grid or Form and the Chart containers.
For example, you are cleansing customer records in a Grid container by correcting missing or invalid values. You can then use the same dataset in a Chart container to visualize customer distribution by region. Since both the Grid and Chart share the same dataset, any changes in the Grid are automatically reflected in the Chart.

Dataset Design Recommendations

Ideal for visualizing flows, conversions, and movement between stages where link width represents quantity.
Requires three columns from a dataset:
Note
You can use the same chart dataset in a Grid component if you plan to modify or manipulate the data.
- Source Field defines the origin nodes where flows begin, for example, Traffic Channel, Department, Entry Page.
- Target Field defines the destination nodes where flows end, for example, Landing Page, Expense Category, Conversion Step.
- Value Field must be a column with NUMERIC(precision, scale) data type. This determines the thickness of flow links, for example, User Count, Revenue, Sessions.
In general, the dataset should contain source-target pairs with aggregated flow values, where one source can connect to multiple targets.
You need to include an additional field in your dataset if you plan to bind the chart dataset to a grid or form component’s dataset. Refer to Data Binding in Charts for more information.

Sankey Chart Example

Sample Dataset

Configuration

Rendered Chart

Configuration Steps

Note
You can interact with Build Assist to quickly configure charts as required by entering a prompt that provides the context of the dataset and the fields to be used.

On the Construct Preview’s home page, edit the required WebApp. The WebApp configuration page is displayed.
Click More Options (…) next to the required page or container node and select Add Chart > Add Sankey Chart.
Click the Sankey Chart node. The Details Pane is updated with the Sankey Chart fields.

Enter the required values for the fields to create a Sankey chart in a container using the following tables:

Field Name	Description	Supported Values/Notes
Name *required*	Name of the Sankey Chart Container.	Enter a name within length constraints. maxLength: 50
Title	Label that is displayed on the top of this chart container.	Enter a title within length constraints. maxLength: 50
Parent Layout Container	Name of the parent container used for page layout. Allows you to link child containers to a parent container.	Select the parent container to house this chart container.
Ordinal	Allows ordering the containers.	Any integer. default: 0
Tab Label	Label displayed as the tab name for a container. Use this property only when a container needs to be included in a tab container.	Enter a name within length constraints. maxLength: 50
Override Datastore	SKP Datastore name for this component that overrides the datastore configured at the WebApp level. Refer to Datastores for more information. Click the Open Details button next to the Datastore list to open it in the SKP Catalog.	NA
Dataset *required*	SKP dataset for the data used for this container. Select the required Dataset. Scroll down the Dataset list to auto-create a dataset using a table or view based on Construct Preview’s recommendation. Note If a dataset is being created from a SQL view, you must set its Affected Table. Click the Open Details button next to the Dataset list to open it in the SKP Catalog.	Note The Update Dataset button opens a dialog box that allows you to rescan the dataset and add any newly available fields from the underlying table or view to the dataset used in this container. Specify the dataset classification. If the scan errors out, access the associated Datastore’s scan logs in the SKP Catalog module to troubleshoot the error.
Source Field *required*	Select a field from the dataset that defines the starting point or origin node for each flow.	Represents where resources, users, or items begin their journey before moving to targets. For example, In a budget flow - `Department` (Marketing, Sales, Operations)
Target Field *required*	Select a field from the dataset that defines the destination or receiving node for each flow.	Represents where resources, users, or items move to from their source. For example, For Department source: `Expense Category` (Salaries, Software, Advertising)
Value Field *required*	Select a field from the dataset that determines the width/thickness of each flow link. Larger values create thicker connections, representing volume or magnitude of flow.	For example, `Revenue` - Dollar amount ($100,000 from Marketing → Advertising)
Chart Layout	Controls the overall orientation and arrangement of the Sankey diagram nodes and flows.	Horizontal: (Left-to-Right) Source nodes on left, target nodes on right Vertical: (Top-to-Bottom) Source nodes on top, target nodes below. default: horizontal
Label Position	Controls where node labels (source/target names) appear relative to their rectangular nodes.	Outside: Labels appear beside nodes, keeping the flow area clean Inside: Labels appear within node rectangles (use when space is limited) default: Outside
Enable Link Gradient	Toggle to apply color gradients to flow links that blend from source color to target color.	Creates visual continuity showing flow direction. default: true
Legend	Toggle to show/hide the legend.	default: false
Parent Binding Container	Select the parent grid/form container type for data binding. Allows you to link between grids/forms and charts.	NA
Container Bindings > Source Column	Note Click Add to set up required number of container bindings. Select the source column in the parent binding container.	Use either the Source Column or the Source Value field, but not both.
Container Bindings > Source Value	A fixed source value for data binding.	Use either the Source Column or the Source Value field, but not both.
Container Bindings > Target Column *required*	Select the target column in the chart container’s dataset.	NA
Columns > Name *required*	Note Click Add to set up required number of columns to control how the fields on the chart will be sorted. Select the field name from the dataset used in the chart container.	NA
Columns > Sort Mode	Used with the Sort Priority field to configure the default column sort order:	Supported Values: None Ascending Descending
Columns > Sort Priority	Used with the Sort Mode field to configure the default column sort order.	Default: 0
Link to Page Name	Select the Page to navigate on click.	NA
Open in New Tab	Enable this toggle to open the chart link in a new browser tab.	NA
Link to Page Bindings > Name *required*	Note Click the Add button to add the required chart link to page bindings criteria. Specify a unique binding name for the page link	Enter a name for binding. maxLength: 256
Link to Page Bindings > Target Column *required*	Specify the target column in the linked page	Enter target column name from your dataset. maxLength: 128
Link to Page Bindings > Target Page Container Name	Specifies the container name in the linked page	Select the name of the grid or form container from the page you’ve selected.
Link to Page Bindings > Source Data Record Field Value	Specifies the source column in the current page	Select source column name from your dataset.
Link to Page Bindings > Fixed Value	Specifies the source value in the current page	Specify the value or the actual record of the source column. maxLength: 255
Display Mode	Configures the display mode	* Card: Card-like format * Empty: No visual elements Default: Card
Layout	Specifies how the containers flow within the page	* FlowHorizontal: Side-by-side display * FlowVertical: Top-to-bottom display
Alignment	Controls the alignment for placing the container	* Start * Stretch * End Default: Stretch
Size	Value of the units that are used to compute the size of a container	Any positive number. minimum: 0, default: 1
Size Units	Units that are used to compute the size of a container	* Pixels * Rem * GrowRatio Default: GrowRatio
Gap	The gap between containers or fields on a property card	Any positive number. minimum: 0, default: 1
Padding	Adjusts the padding inside of the container	Any positive number. minimum: 0, default: 0