Package com.storedobject.chart

Class Axis.Pointer

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.VisiblePart

com.storedobject.chart.Axis.Pointer

All Implemented Interfaces:

ComponentPart, ComponentProperty, VisibleProperty

Enclosing class:

Axis

public static class Axis.Pointer
extends VisiblePart

Represents the axis-pointer shown by the axis. (By default, no axis-pointer will be shown. However, if you create one via Axis.getPointer(boolean), it will be displayed).

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
Pointer()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
final Axis.PointerHandle	getHandle(boolean create)	Get the pointer-handle.
final Axis.PointerLabel	getLabel(boolean create)	Get the label of the pointer.
LineStyle	getLineStyle(boolean create)	Get the line-style of the pointer.
final Shadow	getShadow(boolean create)	Get the shadow-style of the pointer.
Boolean	getSnap()	Get the snap attribute.
Axis.PointerType	getType()	Get the type of the pointer.
void	setHandle(Axis.PointerHandle handle)	Set the pointer-handle.
void	setLabel(Axis.PointerLabel label)	Set the label for the pointer.
void	setLineStyle(LineStyle lineStyle)	Set the line-style of the pointer.
void	setShadow(Shadow shadow)	Set the shadow-style of the pointer.
void	setSnap(Boolean snap)	Set the snap attribute.
void	setType(Axis.PointerType type)	Set the type of the pointer.

Methods inherited from class com.storedobject.chart.VisiblePart

isVisible, setVisible, validate

Methods inherited from class com.storedobject.chart.AbstractPart

equals, getId, getLabelTag, getName, getSerial, getZ, hashCode, hasId, setSerial, setZ

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getRenderingIndex, setName, setRenderingIndex

Methods inherited from interface com.storedobject.chart.VisibleProperty

hide, show

Constructor Details

Pointer

public Pointer()

Constructor.

Method Details

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Overrides:

encodeJSON in class AbstractPart

Parameters:

sb - Encoded JSON string to be appended to this.

getType

public Axis.PointerType getType()

Get the type of the pointer.

Returns:

Pointer-type.

setType

public void setType(Axis.PointerType type)

Set the type of the pointer.

Parameters:

type - Pointer-type.

getSnap

public Boolean getSnap()

Get the snap attribute. This will determine whether to snap to point automatically or not. The default value is auto-determined. This feature usually makes sense in value axis and time axis, where tiny points can be sought automatically.

Returns:

True/false or null if not set (means default).

setSnap

public void setSnap(Boolean snap)

Set the snap attribute. (See getSnap() to understand more about this attribute).

Parameters:

snap - True/false or null.

getLabel

public final Axis.PointerLabel getLabel(boolean create)

Get the label of the pointer.

Parameters:

create - Whether to create if not exists or not.

Returns:

Pointer label.

setLabel

public void setLabel(Axis.PointerLabel label)

Set the label for the pointer.

Parameters:

label - Pointer label.

getLineStyle

public LineStyle getLineStyle(boolean create)

Get the line-style of the pointer.

Parameters:

create - Whether to create if not exists or not.

Returns:

Line-style.

setLineStyle

public void setLineStyle(LineStyle lineStyle)

Set the line-style of the pointer.

Parameters:

lineStyle - Line-style.

getShadow

public final Shadow getShadow(boolean create)

Get the shadow-style of the pointer.

Parameters:

create - Whether to create if not exists or not.

Returns:

Shadow.

setShadow

public void setShadow(Shadow shadow)

Set the shadow-style of the pointer.

Parameters:

shadow - Shadow.

getHandle

public final Axis.PointerHandle getHandle(boolean create)

Get the pointer-handle.

Parameters:

create - Whether to create if not exists or not.

Returns:

Pointer-handle.

setHandle

public void setHandle(Axis.PointerHandle handle)

Set the pointer-handle.

Parameters:

handle - Pointer-handle.