Package org.zkoss.chart

Class Halo

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.Halo

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class Halo
extends Optionable

A Halo options

All the options in this class support DynamicalAttribute.

Author:

hanhsu

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
Halo()

Method Summary

Modifier and Type	Method	Description
HaloAttributes	getHaloAttributes()	Returns the attribute of a Halo options
Number	getOpacity()	Returns the opacity for the halo.
Number	getSize()	Returns the pixel size of the halo.
void	setHaloAttributes(HaloAttributes attributes)	Sets the attribute of a Halo options
void	setOpacity(Number opacity)	Sets the opacity for the halo.
void	setSize(Number size)	Sets the pixel size of the halo.

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

Halo

public Halo()

Method Detail

getHaloAttributes

public HaloAttributes getHaloAttributes()

Returns the attribute of a Halo options

Default: an instance of HaloAttributes.

setHaloAttributes

public void setHaloAttributes(HaloAttributes attributes)

Sets the attribute of a Halo options

Parameters:

attributes - The attribute of a Halo options

getOpacity

public Number getOpacity()

Returns the opacity for the halo.

Default: 0.25.

setOpacity

public void setOpacity(Number opacity)

Sets the opacity for the halo.

Parameters:

opacity - The opacity for the halo. Defaults to 0.25.

getSize

public Number getSize()

Returns the pixel size of the halo. For point markers this is the radius of the halo. For pie slices it is the width of the halo outside the slice. For bubbles it is the width of the halo outside the bubble.

Default: null.

setSize

public void setSize(Number size)

Sets the pixel size of the halo. For point markers this is the radius of the halo. For pie slices it is the width of the halo outside the slice. For bubbles it is the width of the halo outside the bubble.

Parameters:

size - the pixel size of the halo. For point markers this is the radius of the halo. For pie slices it is the width of the halo outside the slice. For bubbles it is the width of the halo outside the bubble.