SankeyDataLabels (The ZK Charts library 11.4.7.0 API)

java.lang.Object
- org.zkoss.chart.Optionable
- - org.zkoss.chart.plotOptions.DataLabels
  - - org.zkoss.chart.plotOptions.SankeyDataLabels

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

Direct Known Subclasses:

OrganizationDataLabels
```
public class SankeyDataLabels
extends DataLabels
```
An option of data labels used for sankey plot.
All the options in this class support DynamicalAttribute.

Since:

7.2.1.0

Author:

rudyhuang

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.zkoss.chart.Optionable
  NOT_NULL_VALUE, options

Constructor Summary

Constructors
Constructor Description

SankeyDataLabels()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getNodeFormat()`	Returns the format string specifying what to show for nodes in tooltip of a diagram series, as opposed to links.
`org.zkoss.json.JavaScriptValue`	`getNodeFormatter()`	Returns a callback for defining the format for nodes in the chart's tooltip, as opposed to links.
`void`	`setNodeFormat(String nodeFormat)`	Sets the format string specifying what to show for nodes in tooltip of a diagram series, as opposed to links.
`void`	`setNodeFormatter(org.zkoss.json.JavaScriptValue nodeFormatter)`	Sets a callback for defining the format for nodes in the chart's tooltip, as opposed to links.

Methods inherited from class org.zkoss.chart.plotOptions.DataLabels
getAlign, getAllowOverlap, getBackgroundColor, getBorderColor, getBorderRadius, getBorderWidth, getColor, getConnectorColor, getConnectorShape, getConnectorWidth, getDefer, getDistance, getFilter, getFormat, getFormatter, getLinkFormat, getLinkTextPath, getNullFormat, getNullFormatter, getOverflow, getPadding, getPointFormat, getRotation, getRotationMode, getShadow, getShape, getStyle, getTextPath, getVerticalAlign, getX, getY, getZIndex, isAlternate, isCrop, isEnabled, isInside, isShadow, isSoftConnector, isUseHTML, setAlign, setAllowOverlap, setAlternate, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setBorderColor, setBorderColor, setBorderRadius, setBorderRadius, setBorderWidth, setColor, setColor, setColor, setColor, setConnectorColor, setConnectorShape, setConnectorWidth, setCrop, setDefer, setDistance, setDistance, setEnabled, setFilter, setFormat, setFormatter, setInside, setLinkFormat, setLinkTextPath, setNullFormat, setNullFormatter, setOverflow, setPadding, setPointFormat, setRotation, setRotation, setRotationMode, setShadow, setShadow, setShape, setSoftConnector, setStyle, setStyle, setTextPath, setUseHTML, setVerticalAlign, setX, setY, setZIndex

Methods inherited from class org.zkoss.chart.Optionable
addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, onChange, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, setAttr, toJSONString, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SankeyDataLabels
```
public SankeyDataLabels()
```
- Method Detail
  - getNodeFormat
```
public String getNodeFormat()
```
    Returns the format string specifying what to show for nodes in tooltip of a diagram series, as opposed to links.
    Default: "{point.name}<br>{point.title}<br>{point.description}"
    
    Overrides:
    
    getNodeFormat in class DataLabels
  - setNodeFormat
```
public void setNodeFormat(String nodeFormat)
```
    Sets the format string specifying what to show for nodes in tooltip of a diagram series, as opposed to links.
    
    Overrides:
    
    setNodeFormat in class DataLabels
  - getNodeFormatter
```
public org.zkoss.json.JavaScriptValue getNodeFormatter()
```
    Returns a callback for defining the format for nodes in the chart's tooltip, as opposed to links.
    Default: null
    
    Overrides:
    
    getNodeFormatter in class DataLabels
  - setNodeFormatter
```
public void setNodeFormatter(org.zkoss.json.JavaScriptValue nodeFormatter)
```
    Sets a callback for defining the format for nodes in the chart's tooltip, as opposed to links.
    
    Overrides:
    
    setNodeFormatter in class DataLabels