Package org.zkoss.chart

Class Position

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.Position

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class Position
extends Optionable

A position option to specify the position for buttons or labels.

All the options in this class support DynamicalAttribute.

Author:

jumperchen

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
Position()
Position(Number x, Number y)
Position(Number x, Number y, String align, String verticalAlign)

Method Summary

Modifier and Type	Method	Description
String	getAlign()	Returns the alignment of the position
String	getRelativeTo()	Returns what the fixed tooltip alignment should be relative to.
String	getVerticalAlign()	Returns the vertical alignment of the position
Number	getX()	Returns the x offset.
Number	getY()	Returns the y offset.
void	setAlign(String align)	Sets the alignment of the position
void	setRelativeTo(String relativeTo)	Sets what the fixed tooltip alignment should be relative to.
void	setVerticalAlign(String verticalAlign)	Sets the vertical alignment of the position
void	setX(Number x)	Sets the x offset.
void	setY(Number y)	Sets the y offset.

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

Position

public Position()

Position

public Position(Number x,
                Number y)

Position

public Position(Number x,
                Number y,
                String align,
                String verticalAlign)

Method Detail

setX

public void setX(Number x)

Sets the x offset.

Parameters:

x -

getX

public Number getX()

Returns the x offset.

setY

public void setY(Number y)

Sets the y offset.

Parameters:

y -

getY

public Number getY()

Returns the y offset.

setAlign

public void setAlign(String align)

Sets the alignment of the position

getAlign

public String getAlign()

Returns the alignment of the position

Default: null

setVerticalAlign

public void setVerticalAlign(String verticalAlign)

Sets the vertical alignment of the position

getVerticalAlign

public String getVerticalAlign()

Returns the vertical alignment of the position

Default: null

setRelativeTo

public void setRelativeTo(String relativeTo)

Sets what the fixed tooltip alignment should be relative to. The default, pane, means that it is aligned within the plot area for that given series. If the tooltip is split (as default in Stock charts), each partial tooltip is aligned within the series' pane. Accepted values: "pane", "chart", "plotBox", "spacingBox" Notice that this property is only used in Tooltip

Default: "pane".

Since:

12.2.0.0

getRelativeTo

public String getRelativeTo()

Returns what the fixed tooltip alignment should be relative to. The default, pane, means that it is aligned within the plot area for that given series. If the tooltip is split (as default in Stock charts), each partial tooltip is aligned within the series' pane. Accepted values: "pane", "chart", "plotBox", "spacingBox" Notice that this property is only used in Tooltip

Default: "pane".

Since:

12.2.0.0