Package org.zkoss.chart

Class PaneBackground

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.PaneBackground

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class PaneBackground
extends Optionable

A option of background for Pane.

All the options in this class support DynamicalAttribute.

Author:

RaymondChao, jumperchen

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
PaneBackground()

Method Summary

Modifier and Type	Method	Description
Color	getBackgroundColor()	Returns the background gradient
Color	getBorderColor()	Returns the border color
Object	getBorderRadius()	Returns the border radius
Number	getBorderWidth()	Returns the border width.
Object	getInnerRadius()	Returns the inner radius
Number	getInnerWidth()	Returns the inner width.
Object	getOuterRadius()	Returns the outer radius.
Number	getOuterWidth()	Returns the outer width.
String	getShape()	Returns the shape option for this pane background object.
void	setBackgroundColor(String color)	Sets the background color
void	setBackgroundColor(Color color)	Sets the background color
void	setBackgroundColor(LinearGradient color)	Sets the background color
void	setBackgroundColor(RadialGradient color)	Sets the background color
void	setBorderColor(String color)	Sets the border color
void	setBorderColor(Color color)	Sets the border color
void	setBorderColor(LinearGradient color)	Sets the border color
void	setBorderColor(RadialGradient color)	Sets the border color
void	setBorderRadius(Number borderRadius)	Sets the border radius.
void	setBorderRadius(String borderRadius)	Sets the border radius.
void	setBorderWidth(Number borderWidth)	Sets the border width.
void	setInnerRadius(Number innerRadius)	Sets the inner radius.
void	setInnerRadius(String innerRadius)	Sets the inner radius.
void	setInnerWidth(Number innerWidth)	Sets the inner width
void	setOuterRadius(Number outerRadius)	Sets the outer radius
void	setOuterRadius(String outerRadius)	Sets the outer radius
void	setOuterWidth(Number outerWidth)	Sets the outer width
void	setShape(String shape)	Sets the shape option for this pane background object.

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

PaneBackground

public PaneBackground()

Method Detail

getBackgroundColor

public Color getBackgroundColor()

Returns the background gradient

Default:

 {
                linearGradient: { x1: 0, y1: 0, x2: 0, y2: 1 },
                stops: [
                        [0, '#FFF'],
                        [1, '#DDD']
                ]
}
 

setBackgroundColor

public void setBackgroundColor(Color color)

Sets the background color

setBackgroundColor

public void setBackgroundColor(String color)

Sets the background color

setBackgroundColor

public void setBackgroundColor(LinearGradient color)

Sets the background color

setBackgroundColor

public void setBackgroundColor(RadialGradient color)

Sets the background color

getBorderColor

public Color getBorderColor()

Returns the border color

Default: "#cccccc"

setBorderColor

public void setBorderColor(Color color)

Sets the border color

setBorderColor

public void setBorderColor(String color)

Sets the border color

setBorderColor

public void setBorderColor(LinearGradient color)

Sets the border color

setBorderColor

public void setBorderColor(RadialGradient color)

Sets the border color

getBorderRadius

public Object getBorderRadius()

Returns the border radius

Default: 0

Since:

11.4.7.0

setBorderRadius

public void setBorderRadius(Number borderRadius)

Sets the border radius.

Since:

11.4.7.0

setBorderRadius

public void setBorderRadius(String borderRadius)

Sets the border radius.

Since:

11.4.7.0

getBorderWidth

public Number getBorderWidth()

Returns the border width.

Default: null.

setBorderWidth

public void setBorderWidth(Number borderWidth)

Sets the border width.

Default: null.

getInnerRadius

public Object getInnerRadius()

Returns the inner radius

Default: 0

setInnerRadius

public void setInnerRadius(Number innerRadius)

Sets the inner radius.

setInnerRadius

public void setInnerRadius(String innerRadius)

Sets the inner radius.

getInnerWidth

public Number getInnerWidth()

Returns the inner width.

Default: 0

setInnerWidth

public void setInnerWidth(Number innerWidth)

Sets the inner width

getOuterRadius

public Object getOuterRadius()

Returns the outer radius.

Default: 105%

setOuterRadius

public void setOuterRadius(String outerRadius)

Sets the outer radius

setOuterRadius

public void setOuterRadius(Number outerRadius)

Sets the outer radius

getOuterWidth

public Number getOuterWidth()

Returns the outer width.

Default: 0

setOuterWidth

public void setOuterWidth(Number outerWidth)

Sets the outer width

Parameters:

outerWidth -

getShape

public String getShape()

Returns the shape option for this pane background object.

setShape

public void setShape(String shape)

Sets the shape option for this pane background object.

Parameters:

shape -