Package com.storedobject.chart

Class SankeyChart

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.Chart

com.storedobject.chart.SelfPositioningSpecialChart

com.storedobject.chart.SankeyChart

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasAnimation, HasData, HasEmphasis, HasPosition

public class SankeyChart
extends SelfPositioningSpecialChart

Sankey chart.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SankeyChart.Edge	Class that defines an edge between 2 Sankey nodes.
static class	SankeyChart.Node	Sankey data node class.

Nested classes/interfaces inherited from class com.storedobject.chart.Chart

Chart.Emphasis, Chart.Label, Chart.LabelPosition

Constructor Summary

Constructors

Constructor	Description
SankeyChart(SankeyDataProvider data)	Create a tree chart of the set of provided data.

Method Summary

Modifier and Type	Method	Description
protected AbstractDataProvider<?>	dataToEmbed()	Get the data to embed.
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
final Chart.Label	getEdgeLabel(boolean create)	Get the label for the edges.
final LineStyle	getLineStyle(boolean create)	Get line style.
final Alignment	getNodeAlignment(boolean create)	Get the current node alignment.
SankeyDataProvider	getSankeyData()	Get the Sankey data associated with this chart.
final void	setData(AbstractDataProvider<?>... data)	Set data for the chart.
final void	setEdgeLabel(Chart.Label edgeLabel)	Set the label for the edges.
void	setHeight(int height)	Set height.
final void	setLineStyle(LineStyle lineStyle)	Set the line style.
final void	setNodeAlignment(Alignment nodeAlignment)	Set node alignment.
final void	setNodeGap(int nodeGap)	Set node gap.
final void	setNodeWidth(int nodeWidth)	Set node width.
void	setSankeyData(SankeyDataProvider data)	Set the Sankey data associated with this chart.
final void	setVertical()	Set the orientation as vertical.
final void	setWidth(int width)	Set width.

Methods inherited from class com.storedobject.chart.SelfPositioningSpecialChart

getPosition, setPosition

Methods inherited from class com.storedobject.chart.Chart

addEvent, addParts, dataValue, dataValueIndex, declareData, getAnimation, getCoordinateSystem, getData, getEmphasis, getEvents, getItemStyle, getLabel, getLabelName, getMarkArea, getMax, getMin, getName, getTooltip, getType, plotOn, plotOn, setAnimation, setColors, setCustomRenderer, setEmphasis, setItemStyle, setLabel, setMarkArea, setName, setTooltip, setType, typeValue, validate

Methods inherited from class com.storedobject.chart.AbstractPart

equals, getId, getLabelTag, getSerial, getZ, hashCode, hasId, setSerial, setZ

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getId, getRenderingIndex, getSerial, setRenderingIndex, setSerial

Constructor Details

SankeyChart

public SankeyChart(SankeyDataProvider data)

Create a tree chart of the set of provided data.

Parameters:

data - Data to be used.

Method Details

setData

public final void setData(AbstractDataProvider<?>... data)

Description copied from class: Chart

Set data for the chart.

Overrides:

setData in class Chart

Parameters:

data - Data to be used (multiples of them for charts that use multi-axis coordinate systems).

getSankeyData

public SankeyDataProvider getSankeyData()

Get the Sankey data associated with this chart.

Returns:

Sankey data.

setSankeyData

public void setSankeyData(SankeyDataProvider data)

Set the Sankey data associated with this chart.

Parameters:

data - Sankey data.

dataToEmbed

protected AbstractDataProvider<?> dataToEmbed()

Description copied from class: Chart

Get the data to embed. This is useful only for those special charts that embed data in the chart itself rather than pointing to the dataset. Example: TreeChart, GaugeChart etc. If null is returned from this method, no data will be embedded.

Overrides:

dataToEmbed in class Chart

Returns:

Data to embed.

setVertical

public final void setVertical()

Set the orientation as vertical.

setHeight

public void setHeight(int height)

Set height.

Parameters:

height - Height.

setWidth

public final void setWidth(int width)

Set width.

Parameters:

width - Width.

setNodeWidth

public final void setNodeWidth(int nodeWidth)

Set node width.

Parameters:

nodeWidth - The node width of rectangle in Sankey diagram.

setNodeGap

public final void setNodeGap(int nodeGap)

Set node gap.

Parameters:

nodeGap - The gap between any two rectangles in each column of the Sankey diagram.

setNodeAlignment

public final void setNodeAlignment(Alignment nodeAlignment)

Set node alignment.

Parameters:

nodeAlignment - Controls the horizontal alignment of nodes in the diagram. When orientation is vertical, it controls vertical alignment.

getNodeAlignment

public final Alignment getNodeAlignment(boolean create)

Get the current node alignment. If true is passed as the parameter, a new alignment will be created if it doesn't exist.

Parameters:

create - True/false.

Returns:

Alignment.

setEdgeLabel

public final void setEdgeLabel(Chart.Label edgeLabel)

Set the label for the edges.

Parameters:

edgeLabel - Edge label to set.

getEdgeLabel

public final Chart.Label getEdgeLabel(boolean create)

Get the label for the edges.

Parameters:

create - Pass true if it needs to be created if not exists.

Returns:

Label.

setLineStyle

public final void setLineStyle(LineStyle lineStyle)

Set the line style.

Parameters:

lineStyle - Line style.

getLineStyle

public final LineStyle getLineStyle(boolean create)

Get line style.

Parameters:

create - Pass true if it needs to be created if not exists.

Returns:

Line style.

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Overrides:

encodeJSON in class Chart

Parameters:

sb - Encoded JSON string to be appended to this.