public final class SankeyDataset extends Dataset
Modifier and Type | Class and Description |
---|---|
static class |
SankeyDataset.DataPointFactory
Factory to create a sankey data point from a native object, used for array container lists.
|
Dataset.CanvasObjectProperty, Dataset.CommonProperty
Modifier and Type | Field and Description |
---|---|
static SankeyDataset.DataPointFactory |
DATAPOINTS_FACTORY
Factory to create
SankeyDataPoint s. |
static String |
DEFAULT_BORDER_COLOR
Default element border color,
HtmlColor.BLACK . |
static int |
DEFAULT_BORDER_WIDTH
Default element border width, 1.
|
static String |
DEFAULT_COLOR
Default element color,
HtmlColor.BLACK . |
static String |
DEFAULT_COLOR_FROM
Default starting color,
HtmlColor.RED . |
static String |
DEFAULT_COLOR_TO
Default ending color,
HtmlColor.GREEN . |
static int |
DEFAULT_NODE_WIDTH
Default element width, 10.
|
DEFAULT_HIDDEN, DEFAULT_NORMALIZED, DEFAULT_PARSING
Constructor and Description |
---|
SankeyDataset()
Creates a data set.
It uses the global options has default. |
SankeyDataset(IsDefaultOptions defaultValues)
Creates a data set setting the defaults value.
|
Modifier and Type | Method and Description |
---|---|
IsColor |
getBorderColor()
Returns the border color of the sankey elements.
|
String |
getBorderColorAsString()
Returns the border color of the sankey elements.
|
int |
getBorderWidth()
Returns the width of the border in pixels of sankey elements.
|
double |
getClip()
Returns always
Undefined.DOUBLE because is always disabled. |
Clip |
getClipAsObject()
Returns always
Clip instance with Undefined.DOUBLE because is always disabled. |
IsColor |
getColor()
Returns the font color of the sankey elements.
|
String |
getColorAsString()
Returns the font color of the sankey elements.
|
List<IsColor> |
getColorFrom()
Returns the starting color of the flow between sankey elements.
|
List<String> |
getColorFromAsString()
Returns the starting color of the flow between sankey elements.
|
ColorCallback<DatasetContext> |
getColorFromCallback()
Returns the color "from" callback, if set, otherwise
null . |
ColorMode |
getColorMode()
Returns the color mode between sankey elements.
|
ColorModeCallback |
getColorModeCallback()
Returns the color mode callback, if set, otherwise
null . |
List<IsColor> |
getColorTo()
Returns the ending color of the flow between sankey elements.
|
List<String> |
getColorToAsString()
Returns the ending color of the flow between sankey elements.
|
ColorCallback<DatasetContext> |
getColorToCallback()
Returns the color "to" callback, if set, otherwise
null . |
List<Double> |
getData(boolean binding)
Throws an exception because not available.
|
List<SankeyDataPoint> |
getDataPoints()
Returns the sankey data property of a dataset for a chart is specified as an array of sankey data points
|
List<SankeyDataPoint> |
getDataPoints(boolean binding)
Returns the sankey data property of a dataset for a chart is specified as an array of sankey data points
|
IsFont |
getFont()
Returns the the font object.
|
FontCallback<DatasetContext> |
getFontCallback()
Returns the font callback, if set, otherwise
null . |
Labels |
getLabels()
Returns the map for labeling the sankey elements.
|
int |
getNodeWidth()
Returns the width of sankey elements.
|
double |
getPadding()
Returns the padding between the top of the node and the first label to draw, when multiple lines for labels are set, in pixels.
|
PaddingCallback |
getPaddingCallback()
Returns the padding callback, if set, otherwise
null . |
Priority |
getPriority()
Returns the map for assigning a priority to the sankey elements.
|
Size |
getSize()
Returns
Size.MIN if flow overlap is preferred. |
SizeCallback |
getSizeCallback()
Returns the size callback, if set, otherwise
null . |
void |
setBorderColor(IsColor borderColor)
Sets the border color of the sankey elements.
|
void |
setBorderColor(String borderColor)
Sets the border color of the sankey elements.
|
void |
setBorderWidth(int borderWidth)
Sets the width of the border in pixels of sankey elements.
|
void |
setClip(boolean clip)
Sets how to clip relative to the chart area.
If false allows overflow, otherwise true clips that many pixels inside the chart area. |
void |
setClip(Clip clip)
Sets how to clip relative to the chart area.
This is ignored in order to disable clipping. |
void |
setClip(double clip)
Sets how to clip relative to the chart area.
This is ignored in order to disable clipping. |
void |
setColor(IsColor color)
Sets the font color of the sankey elements.
|
void |
setColor(String color)
Sets the font color of the sankey elements.
|
void |
setColorFrom(ColorCallback<DatasetContext> colorCallback)
Sets the color "from" callback.
|
void |
setColorFrom(IsColor... colors)
Sets the starting color of the flow between sankey elements.
|
void |
setColorFrom(NativeCallback colorCallback)
Sets the color "from" callback.
|
void |
setColorFrom(String... colors)
Sets the starting color of the flow between sankey elements.
|
void |
setColorMode(ColorMode colorMode)
Sets the color mode between sankey elements.
|
void |
setColorMode(ColorModeCallback colorModeCallback)
Sets the color mode callback.
|
void |
setColorMode(NativeCallback colorModeCallback)
Sets the color mode callback.
|
void |
setColorTo(ColorCallback<DatasetContext> colorCallback)
Sets the color "to" callback.
|
void |
setColorTo(IsColor... colors)
Sets the ending color of the flow between sankey elements.
|
void |
setColorTo(NativeCallback colorCallback)
Sets the color "to" callback.
|
void |
setColorTo(String... colors)
Sets the ending color of the flow between sankey elements.
|
void |
setData(double... values)
Throws an exception because not available.
|
void |
setData(List<Double> values)
Throws an exception because not available.
|
void |
setDataPoints(List<SankeyDataPoint> datapoints)
Sets the data property of a data set for a chart is specified as an array of data points.
|
void |
setDataPoints(SankeyDataPoint... datapoints)
Sets the data property of a data set for a chart is specified as an array of data points.
|
void |
setFont(FontCallback<DatasetContext> fontCallback)
Sets the font callback.
|
void |
setFont(NativeCallback fontCallback)
Sets the font callback.
|
void |
setLabels(Labels labels)
Sets the map for labeling the sankey elements.
|
void |
setNodeWidth(int nodeWidth)
Sets the width of sankey elements.
|
void |
setPadding(double padding)
Sets the padding between the top of the node and the first label to draw, when multiple lines for labels are set, in pixels.
|
void |
setPadding(NativeCallback paddingCallback)
Sets the padding callback.
|
void |
setPadding(PaddingCallback paddingCallback)
Sets the padding callback.
|
void |
setParsing(boolean parsing)
Sets how to parse the data set.
This is ignored because it must alwasy set to true . |
void |
setPriority(Priority priority)
Sets the map for assigning a priority to the sankey elements.
|
void |
setSize(NativeCallback sizeCallback)
Sets the size callback.
|
void |
setSize(Size size)
Sets
Size.MIN if flow overlap is preferred. |
void |
setSize(SizeCallback sizeCallback)
Sets the size callback.
|
createContext, getAnimationContainer, getBackgroundColorCallback, getBorderColorCallback, getData, getDataCount, getDataset, getDataType, getDefaultBackgroundColorAsString, getDefaultBorderColorAsString, getDefaultBorderWidth, getDefaultHoverBackgroundColorAsString, getDefaultHoverBorderColorAsString, getDefaultHoverBorderWidth, getDefaultValues, getHoverBackgroundColorCallback, getHoverBorderColorCallback, getId, getLabel, getOptions, getOptions, getScope, getType, getTypedDataset, hasOptions, invokeColorCallback, isClip, isHidden, isNormalized, isParsing, removeOptions, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setHidden, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBorderColor, setHoverBorderColor, setLabel, setNormalized, setOptions, setOptions
checkAndAddToParent, getChildKey, getParentNode, getRootNode, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent
checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAnimation, getAnimations, getTransitions, isAnimationEnabled, setAnimationEnabled
extractScope
public static final SankeyDataset.DataPointFactory DATAPOINTS_FACTORY
SankeyDataPoint
s.public static final String DEFAULT_COLOR_FROM
HtmlColor.RED
.public static final String DEFAULT_COLOR_TO
HtmlColor.GREEN
.public static final String DEFAULT_COLOR
HtmlColor.BLACK
.public static final String DEFAULT_BORDER_COLOR
HtmlColor.BLACK
.public static final int DEFAULT_BORDER_WIDTH
public static final int DEFAULT_NODE_WIDTH
public SankeyDataset()
public SankeyDataset(IsDefaultOptions defaultValues)
defaultValues
- default optionspublic IsFont getFont()
public void setLabels(Labels labels)
labels
- the map for labeling the sankey elementspublic Labels getLabels()
public void setPriority(Priority priority)
priority
- the map for assigning a priority to the sankey elementspublic Priority getPriority()
public void setDataPoints(SankeyDataPoint... datapoints)
datapoints
- an array of data pointspublic void setDataPoints(List<SankeyDataPoint> datapoints)
datapoints
- a list of data pointspublic List<SankeyDataPoint> getDataPoints()
public List<SankeyDataPoint> getDataPoints(boolean binding)
binding
- if true
binds the new array list in the containerpublic void setSize(Size size)
Size.MIN
if flow overlap is preferred.size
- Size.MIN
if flow overlap is preferredpublic Size getSize()
Size.MIN
if flow overlap is preferred.Size.MIN
if flow overlap is preferredpublic void setColorMode(ColorMode colorMode)
colorMode
- the color mode between sankey elementspublic ColorMode getColorMode()
public void setColorFrom(IsColor... colors)
colors
- the starting color of the flow between sankey elementspublic void setColorFrom(String... colors)
colors
- the starting color of the flow between sankey elementspublic List<String> getColorFromAsString()
public List<IsColor> getColorFrom()
public void setColorTo(IsColor... colors)
colors
- the ending color of the flow between sankey elementspublic void setColorTo(String... colors)
colors
- the ending color of the flow between sankey elementspublic List<String> getColorToAsString()
public List<IsColor> getColorTo()
public void setBorderColor(IsColor borderColor)
borderColor
- the border color of the sankey elementspublic void setBorderColor(String borderColor)
borderColor
- the border color of the sankey elementspublic String getBorderColorAsString()
public IsColor getBorderColor()
public void setColor(IsColor color)
color
- the font color of the sankey elementspublic void setColor(String color)
color
- the font color of the sankey elementspublic String getColorAsString()
public IsColor getColor()
public void setBorderWidth(int borderWidth)
borderWidth
- the width of the border in pixels of sankey elementspublic int getBorderWidth()
public void setNodeWidth(int nodeWidth)
nodeWidth
- the width of sankey elementspublic int getNodeWidth()
public void setPadding(double padding)
padding
- the padding between the top of the node and the first label to draw, when multiple lines for labels are set, in pixelspublic double getPadding()
public ColorCallback<DatasetContext> getColorFromCallback()
null
.null
.public void setColorFrom(ColorCallback<DatasetContext> colorCallback)
colorCallback
- the color "from" callback.public void setColorFrom(NativeCallback colorCallback)
colorCallback
- the color "from" callback.public ColorCallback<DatasetContext> getColorToCallback()
null
.null
.public void setColorTo(ColorCallback<DatasetContext> colorCallback)
colorCallback
- the color "to" callback.public void setColorTo(NativeCallback colorCallback)
colorCallback
- the color "to" callback.public ColorModeCallback getColorModeCallback()
null
.null
.public void setColorMode(ColorModeCallback colorModeCallback)
colorModeCallback
- the color mode callback.public void setColorMode(NativeCallback colorModeCallback)
colorModeCallback
- the color mode callback.public SizeCallback getSizeCallback()
null
.null
.public void setSize(SizeCallback sizeCallback)
sizeCallback
- the size callback.public void setSize(NativeCallback sizeCallback)
sizeCallback
- the size callback.public PaddingCallback getPaddingCallback()
null
.null
.public void setPadding(PaddingCallback paddingCallback)
paddingCallback
- the padding callback.public void setPadding(NativeCallback paddingCallback)
paddingCallback
- the padding callback.public FontCallback<DatasetContext> getFontCallback()
null
.null
.public void setFont(FontCallback<DatasetContext> fontCallback)
fontCallback
- the font callback.public void setFont(NativeCallback fontCallback)
fontCallback
- the font callback.public void setParsing(boolean parsing)
true
.setParsing
in class Dataset
parsing
- how to parse the data set.true
.public void setClip(boolean clip)
false
allows overflow, otherwise true
clips that many pixels inside the chart area.public void setClip(double clip)
public void setClip(Clip clip)
public double getClip()
Undefined.DOUBLE
because is always disabled.getClip
in class Dataset
Undefined.DOUBLE
because is always disabled.public Clip getClipAsObject()
Clip
instance with Undefined.DOUBLE
because is always disabled.getClipAsObject
in class Dataset
Clip
instance with Undefined.DOUBLE
because is always disabled.public void setData(double... values)