SankeyOptions

Options for Sankey diagram

Name	Type	Description
colorGenerator?	ColorGenerator	Optional function to call in order to establish the color to be used for each series
csvData?	string	Optional CSV data to load. Each line should be in the format source,target,value.
dataSource?	DataSource	Optional data source (of type DataSource, meaning both VisuallyJsModel and Selection are supported) from which to retrieve data to load into the chart.
dataSourceFilter?	ChartModelFilter	When you provide dataSource, you can also provide a filter which accepts or rejects specific nodes/groups in the data source.
defaultColor?	string	Optional color to use for every series. Overrides any colorGenerator.
emptyMessage?	string	Message to display when the chart has no data. Defaults to "No data".
height?	number	Height for the chart. If omitted, height is computed from the width of the chart's container
interactive?	boolean	Defaults to true - the charts responds to mouse hover events and highlights edges, nodes and paths.
jsonData?	VisuallyJsDefaultJSON	Optional dataset to load.
labelProperty?	string	When using a data source, this property tells the chart which field contains node labels. It defaults to labels. If there is no value provided for the property with this key, the node's ID is used as the label.
labels?	{   backgroundColor:string,   font:FontSpec,   padding:number }	Options for the node labels.
legend?	boolean | LegendSpec	Either a boolean true/false, indicating the legend should be shown/hidden, or a spec for a legend.
linkColor?	string	Link color to use when linkColorStrategy is 'static'. Defaults to "#444444"
linkColorStrategy?	"source" | "target" | "static" | "source-target"	Strategy for link color: static uses a single color, source-target paints a gradient from source to target, target uses the target node color, source uses the source node color.
nodePadding?	number	Spacing, in pixels, between nodes. Defaults to 10.
nodeWidth?	number	Width, in pixels, of nodes. Defaults to 15.
padding?	number	Padding to leave around the chart. Defaults to 20 pixels.
resizeObserver?	boolean	Defaults to true, meaning the chart will redraw when its container element resizes.
style?	ChartStyleOptions	Styles for legend and grid.
subtitle?	SubtitleSpec	Subtitle for the chart.
title?	ChartTitleSpec	Title for the chart.
titlePadding?	number	Padding to leave underneath the title
tooltip?	TooltipOptions	Options for a tooltip for the chart.
tooltipSuffix?	string	Optional suffix to append to tooltip labels.
url?	string	Optional URL from which to retrieve data to load into the chart
valueProperty?	string	When using a data source, this property tells the chart which field contains edge values. It defaults to value.
width?	number	Width for the chart. If omitted, width is computed from the width of the chart's container
zoom?	{   enabled:boolean,   initialValue:number,   range:[number, number] }	Optional zoom configuration.