Skip to main content
Basic Usage 
{% sankey_chart
    data="demo_order_details"
    source="category"
    target="item_name"
    value="sum(quantity)"
/%}

​
Examples

​
Sankey Chart with Custom Colors

Sankey Chart with Custom Colors 
{% sankey_chart
    data="demo_order_details"
    source="category"
    target="item_name"
    value="sum(quantity)"
    title="Category to Item Flow"
    chart_options={
        color_palette = ["#0d0887", "#6300a7", "#a62098", "#d5546e", "#f68d45", "#fcd225", "#f0f921"]
    }
/%}

​
Attributes

​
data
String
required
Name of the table to query
​
filters
Array
default:"[]"
Array of column names to use as filters
​
date_range
Use date_range to filter data for specific time periods. Accepts predefined ranges (e.g., “last 12 months”), dynamic ranges (e.g., “Last 90 days”), custom date ranges (e.g., “2020-01-01 to 2023-03-01”), or partial ranges (e.g., “from 2020-01-01”, “until 2023-03-01”)Example:
date_range={
  range = value
  date = "string"
}
Attributes:
  • range: enum
  • date: string
​
source
String
required
Column name for source nodes
​
target
String
required
Column name for target nodes
​
value
String
required
Column name for flow values
​
percent
String
Column name for percentage values (optional)
​
title
String
Title to display above the chart
​
subtitle
String
Subtitle to display below the title
​
info
String
Information tooltip text (can only be used with title)
​
info_link
String
URL to link the info text to (can only be used with info)
​
info_link_title
String
Create a custom link title for the info link, placed after the info text (can only be used with info_link)
​
value_fmt
String
default:"num"
Format for values
​
node_labels
String
default:"name"
Node label displayAllowed values:
  • name
  • value
  • full
​
link_labels
String
Link label displayAllowed values:
  • value
  • percent
  • full
  • none
​
node_align
String
default:"justify"
Node alignmentAllowed values:
  • justify
  • left
  • right
  • top
  • bottom
​
node_gap
Number
default:"10"
Gap between nodes in pixels
​
node_width
Number
default:"20"
Width of nodes in pixels
​
orient
String
default:"horizontal"
OrientationAllowed values:
  • horizontal
  • vertical
​
sort
Boolean
default:"false"
Sort nodes by value
​
link_color
String
default:"source"
Link color modeAllowed values:
  • source
  • target
  • gradient
​
outline_color
String
Node outline color
​
outline_width
Number
default:"0"
Node outline width in pixels
​
chart_options
default:"{}"
Chart configuration optionsExample:
chart_options={
  color_palette = []
}
Attributes:
  • color_palette: array
​
where
String
Custom SQL WHERE condition to apply to the query. For date filters, use date_range instead.
​
having
String
Custom SQL HAVING condition to apply to the query after GROUP BY
​
limit
Number
Maximum number of rows to return from the query
​
order
String
Column name(s) with optional direction (e.g. “column_name”, “column_name desc”)
​
qualify
String
Custom SQL QUALIFY condition to filter windowed results
​
width
Number
Set the width of this component (in percent) relative to the page width