Package org.zkoss.chart

Class Pane

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.Pane

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class Pane
extends Optionable

Applies only to polar charts and angular gauges. This configuration object holds general options for the combined X and Y axes set. Each xAxis or yAxis can reference the pane by index.

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

Method Summary

Modifier and Type	Method	Description
List<PaneBackground>	getBackground()	Returns a list of objects, for backgrounds.
Number	getBorderWidth()	Returns the border width of the pane.
List<Object>	getCenter()	Returns the center of a polar chart or angular gauge, given as an array of [x, y] positions.
Number	getEndAngle()	Returns the end angle of the polar X axis or gauge value axis, given in degrees where 0 is north.
Object	getInnerSize()	Returns the innerSize of the pane.
Object	getSize()	Returns the size of the pane.
Number	getStartAngle()	Returns the start angle of the polar X axis or gauge axis, given in degrees where 0 is north.
void	setBackground(List<PaneBackground> background)	Sets a list of objects, for backgrounds.
void	setBorderWidth(Number borderWidth)	Sets the border width of the pane.
void	setCenter(Object... center)
void	setCenter(List<Object> center)	Sets the center of a polar chart or angular gauge, given as an array of [x, y] positions.
void	setEndAngle(Number endAngle)	Sets the end angle of the polar X axis or gauge value axis, given in degrees where 0 is north.
void	setInnerSize(Number innerSize)	Sets the innerSize of the pane.
void	setInnerSize(String innerSize)	Sets the innerSize of the pane.
void	setSize(Number size)	Sets the size of the pane.
void	setSize(String size)	Sets the size of the pane.
void	setStartAngle(Number startAngle)	Sets the start angle of the polar X axis or gauge axis, given in degrees where 0 is north.

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

Pane

public Pane()

Method Detail

getBackground

public List<PaneBackground> getBackground()

Returns a list of objects, for backgrounds. Sub options include backgroundColor (which can be solid or gradient), innerWidth, outerWidth, borderWidth, borderColor.

setBackground

public void setBackground(List<PaneBackground> background)

Sets a list of objects, for backgrounds. Sub options include backgroundColor (which can be solid or gradient), innerWidth, outerWidth, borderWidth, borderColor. 'background an object, or array of objects, for backgrounds. Sub options include backgroundColor (which can be solid or gradient), innerWidth, outerWidth, borderWidth, borderColor.

getBorderWidth

public Number getBorderWidth()

Returns the border width of the pane.

Default: null.

setBorderWidth

public void setBorderWidth(Number borderWidth)

Sets the border width of the pane.

Default: null

getCenter

public List<Object> getCenter()

Returns the center of a polar chart or angular gauge, given as an array of [x, y] positions. Positions can be given as integers that transform to pixels, or as percentages of the plot area size.

Returns:

center the center of a polar chart or angular gauge, given as an array of [x, y] positions. Positions can be given as integers that transform to pixels, or as percentages of the plot area size.

setCenter

public void setCenter(List<Object> center)

Sets the center of a polar chart or angular gauge, given as an array of [x, y] positions. Positions can be given as integers that transform to pixels, or as percentages of the plot area size. 'center the center of a polar chart or angular gauge, given as an array of [x, y] positions. Positions can be given as integers that transform to pixels, or as percentages of the plot area size.

Sample values:

1. 10 (as in 10 pixels)
2. 75% (as in 75% position of the plot area size)

setCenter

public void setCenter(Object... center)

Parameters:

center -

See Also:

setCenter(List)

getEndAngle

public Number getEndAngle()

Returns the end angle of the polar X axis or gauge value axis, given in degrees where 0 is north.

Defaults to getStartAngle() + 360.

setEndAngle

public void setEndAngle(Number endAngle)

Sets the end angle of the polar X axis or gauge value axis, given in degrees where 0 is north.

Defaults to getStartAngle() + 360.

getStartAngle

public Number getStartAngle()

Returns the start angle of the polar X axis or gauge axis, given in degrees where 0 is north.

Defaults to 0.

setStartAngle

public void setStartAngle(Number startAngle)

Sets the start angle of the polar X axis or gauge axis, given in degrees where 0 is north.

Defaults to 0.

getSize

public Object getSize()

Returns the size of the pane.

Default: null

setSize

public void setSize(Number size)

Sets the size of the pane.

Parameters:

size -

setSize

public void setSize(String size)

Sets the size of the pane.

Parameters:

size -

getInnerSize

public Object getInnerSize()

Returns the innerSize of the pane.

Default: null

setInnerSize

public void setInnerSize(Number innerSize)

Sets the innerSize of the pane.

Parameters:

innerSize -

setInnerSize

public void setInnerSize(String innerSize)

Sets the innerSize of the pane.

Parameters:

innerSize -