Sankey Diagram

This article describes the Sankey Diagram component and its properties.

The Sankey Diagram is a visualization component used to depict a flow from one set of values to another. The things being connected are called nodes and the connections are called links.

Select Sankey Diagram from the Data Visualization category of the component library. Move the mouse over the canvas and click to add a Sankey diagram to your project:

Sankey Diagram Properties

The Sankey Diagram properties consist of DATA, STYLE, and DYNAMIC VISIBILITY drawers. This guide will not describe the dynamic visibility properties as these are generic to each visible component; a separate guide and tutorial on dynamic visibility can be found here.

---

DATA

• Data Block - bound to the spreadsheet, this determines the data that is displayed on the diagram.

• Color Block - bound to the spreadsheet, this determines the color that is displayed for each of the data points on the diagram.

On the property panel, you can download a sample data structure that displays how the data should be formatted in the spreadsheet.

---

STYLE

• Chart Padding – This property defines the space between the diagram border and the component content. It can be set in 3 ways:

  • Selecting the input up-down arrows.

  • Typing in a value.

  • Binding to value in a spreadsheet cell.

• Truncate long text - check this option to truncate long text values on the diagram.

• Wrap text - check this option to wrap any long text strings on the diagram.

PATHS

• Path Style -

  • Default

    • Border - a property to change the color of the component border. This is checked by default. Uncheck to disable the border.

      • Opacity - a property to change the opacity of the component border. This is checked by default. Uncheck to disable the border.

  • Colored

    • From node - applies a solid color to the node connections based on the 'From' node.

    • To node - applies a solid color to the node connections based on the 'To' node.

  • Gradient - applies a gradient based on the set node colors.

LABELS

• Font – Choose a font style from the dropdown list.

• Size – Change the font size of the text.

• Default Text Color – The text will be shown in the color that matches the value entered in the property field.

  • Opacity – This determines the transparency of the text.

DATA TOOLTIPS

• Font – Choose a font style from the dropdown list.

• Size – Change the font size of the text.

• Line height – Use this property to adjust the line spacing of the Text Label. Choose one of the options from the dropdown list.

• Default Text Color – The text will be shown in the color that matches the value entered in the property field.

  • Opacity – This determines the transparency of the text.

• Padding – This property defines the space between the tooltip border and the tooltip content.

• Tooltip style -

  • Square corner - applies a square cornering to the tooltip

  • Rounded corner - applies a rounded cornering to the tooltip

• Background Fill - a property to change the color of the tooltip background

  • Colour can be set in 3 ways

    • Clicking the colored rectangle and using the color picker

    • Typing in a color value (as HEX code)

    • Binding to a color value in a spreadsheet cell (formats included below)

      • A color name - e.g. red, green, blue-violet, steel blue

      • a HEX code - e.g. #ff2233

      • an RGB specifier - e.g. rgb(255,40,75)

      • A HSL specifier - e.g. hsl(120, 100%, 50%)

  • Opacity can be set in 3 different ways:

    • Using the spinner buttons

    • Typing in a value

    • Binding to value in a spreadsheet cell

• Border - a property to change the color of the tooltip border.

  • Opacity - a property to change the opacity of the tooltip border.

• Effects – Select an option from the dropdown box. The options are none and Drop Shadow. With Drop Shadow selected the following properties appear:

  • Color – this determines the color of the shadow

  • Opacity – this determines the opacity of the shadow

  • X-Offset – determines the horizontal position of the shadow (positive values move to the right, negative values move to the left)

  • Y-Offset – determines the vertical position of the shadow (positive values move down, negative values move up)

  • Blur – determines the blur of the shadow