Package org.zkoss.chart

Class ColorVariation

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.ColorVariation

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class ColorVariation
extends Optionable

A configuration object to define how the color of a child varies from the parent's color. The variation is distributed among the children of node. For example when setting brightness, the brightness change will range from the parent's original brightness on the first child, to the amount set in the to setting on the last node. This allows a gradient-like color scheme that sets children out from each other while highlighting the grouping on treemaps and sectors on sunburst charts.

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
ColorVariation()

Method Summary

Modifier and Type	Method	Description
String	getKey()	Returns the key of a color variation.
Number	getTo()	Returns the ending value of a color variation.
void	setKey(String key)	Sets the key of a color variation.
void	setTo(Number to)	Sets the ending value of a color variation.

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

ColorVariation

public ColorVariation()

Method Detail

getKey

public String getKey()

Returns the key of a color variation. Currently supports brightness only.

Default: null

setKey

public void setKey(String key)

Sets the key of a color variation. Currently supports brightness only.

getTo

public Number getTo()

Returns the ending value of a color variation. The last sibling will receive this value.

Default: null

setTo

public void setTo(Number to)

Sets the ending value of a color variation. The last sibling will receive this value.