org.fujion.highcharts

Class PlotSankey

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.PlotOptions

org.fujion.highcharts.PlotSankey

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class PlotSankey
extends PlotOptions

Options for sankey diagram.

A sankey diagram is a type of flow diagram, in which the width of the link between two nodes is shown proportionally to the flow quantity.

Field Summary

Fields

Modifier and Type	Field and Description
Double	curveFactor Higher numbers makes the links in a sankey diagram render more curved.
Double	linkOpacity Opacity for the links between nodes in the sankey diagram.
Integer	nodePadding The padding between nodes in a sankey diagram, in pixels.
Integer	nodeWidth The pixel width of each node in a sankey diagram, or the height in case the chart is inverted.

Fields inherited from class org.fujion.highcharts.PlotOptions

allowPointSelect, animation, animationLimit, boostThreshold, className, color, colorByPoint, colorIndex, colors, connectEnds, connectNulls, cropThreshold, cursor, dashStyle, dataLabels, description, enableMouseTracking, exposeElementToA11y, findNearestPointBy, getExtremesFromAll, id, keys, label, linecap, lineWidth, linkedTo, marker, negativeColor, pointInterval, pointIntervalUnit, pointPlacement, pointStart, selected, shadow, showCheckbox, showInLegend, skipKeyboardNavigation, softThreshold, stacking, step, stickyTracking, threshold, tooltip, turboThreshold, type, visible, zoneAxis, zones

Constructor Summary

Constructors

Constructor and Description
PlotSankey()

Method Summary

Methods inherited from class org.fujion.highcharts.PlotOptions

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

transformForClient

Field Detail

curveFactor

@Option
public Double curveFactor

Higher numbers makes the links in a sankey diagram render more curved. A curveFactor of 0 makes the lines straight. Defaults to 0.33.

linkOpacity

@Option
public Double linkOpacity

Opacity for the links between nodes in the sankey diagram. Defaults to 0.5.

nodePadding

@Option
public Integer nodePadding

The padding between nodes in a sankey diagram, in pixels. Defaults to 10.

nodeWidth

@Option
public Integer nodeWidth

The pixel width of each node in a sankey diagram, or the height in case the chart is inverted. Defaults to 20.

Constructor Detail

PlotSankey

public PlotSankey()