org.pepstock.charba.client.annotation

Class LineAnnotation

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.plugins.AbstractPluginOptions

org.pepstock.charba.client.annotation.AbstractAnnotation

org.pepstock.charba.client.annotation.LineAnnotation

public final class LineAnnotation
extends AbstractAnnotation

Implements a LINE annotation which draws a line into a chart.
Vertical or horizontal lines are supported.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static IsColor	DEFAULT_BORDER_COLOR Default line annotation border color, rgb(54, 162, 235).
static String	DEFAULT_BORDER_COLOR_AS_STRING Default line annotation border color as string, rgb(54, 162, 235).
static int	DEFAULT_BORDER_WIDTH Default line annotation border width, 2.
static String	DEFAULT_ID Default line annotation ID, "a-line-1".
static LineMode	DEFAULT_MODE Default line annotation mode, LineMode.VERTICAL.

Constructor Summary

Constructors

Constructor and Description
LineAnnotation() Creates a line annotation to be added to an AnnotationOptions instance.
LineAnnotation(IsChart chart) Creates a line annotation to be added to an AnnotationOptions instance, relating to chart instance for default.

Method Summary

Modifier and Type	Method and Description
String	getBorderColorAsString() Returns the color of the border of annotation.
List<Integer>	getBorderDash() Returns the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
int	getBorderDashOffset() Returns the line dash pattern offset or "phase".
int	getBorderWidth() Returns the width of the border in pixels.
Date	getEndValueAsDate() Returns the data value at which the line draw should end.
double	getEndValueAsDouble() Returns the data value at which the line draw should end.
String	getEndValueAsString() Returns the data value at which the line draw should end.
LineLabel	getLabel() Returns the label on the line.
LineMode	getMode() Returns the orientation (horizontal or vertical) of the line.
String	getScaleID() Returns the ID of the scale to bind onto.
Date	getValueAsDate() Returns the data value to draw the line at.
double	getValueAsDouble() Returns the data value to draw the line at.
String	getValueAsString() Returns the data value to draw the line at.
void	setBorderDash(int... borderDash) Sets the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
void	setBorderDashOffset(int borderDashOffset) Sets the line dash pattern offset or "phase".
void	setEndValue(Date endValue) Sets the data value at which the line draw should end.
void	setEndValue(double endValue) Sets the data value at which the line draw should end.
void	setEndValue(String endValue) Sets the data value at which the line draw should end.
void	setMode(LineMode mode) Sets the orientation (horizontal or vertical) of the line.
void	setScaleID(String scaleId) Sets the ID of the scale to bind onto.
void	setValue(Date value) Sets the data value to draw the line at.
void	setValue(double value) Sets the data value to draw the line at.
void	setValue(String value) Sets the data value to draw the line at.

Methods inherited from class org.pepstock.charba.client.annotation.AbstractAnnotation

getBorderColor, getClickCallback, getContextMenuCallback, getDoubleClickCallback, getDrawTime, getMouseDownCallback, getMouseEnterCallback, getMouseLeaveCallback, getMouseMoveCallback, getMouseOutCallback, getMouseOverCallback, getMouseUpCallback, getName, getType, getWheelCallback, setBorderColor, setBorderColor, setBorderWidth, setClickCallback, setContextMenuCallback, setDoubleClickCallback, setDrawTime, setMouseDownCallback, setMouseEnterCallback, setMouseLeaveCallback, setMouseMoveCallback, setMouseOutCallback, setMouseOverCallback, setMouseUpCallback, setName, setWheelCallback

Methods inherited from class org.pepstock.charba.client.plugins.AbstractPluginOptions

getId, getPluginId, loadGlobalsPluginOptions, store, store, store, store

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

checkValue, empty, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ID

public static final String DEFAULT_ID

Default line annotation ID, "a-line-1".

See Also:

Constant Field Values

DEFAULT_BORDER_COLOR

public static final IsColor DEFAULT_BORDER_COLOR

Default line annotation border color, rgb(54, 162, 235).

DEFAULT_BORDER_COLOR_AS_STRING

public static final String DEFAULT_BORDER_COLOR_AS_STRING

Default line annotation border color as string, rgb(54, 162, 235).

DEFAULT_BORDER_WIDTH

public static final int DEFAULT_BORDER_WIDTH

Default line annotation border width, 2.

See Also:

Constant Field Values

DEFAULT_MODE

public static final LineMode DEFAULT_MODE

Default line annotation mode, LineMode.VERTICAL.

Constructor Detail

LineAnnotation

public LineAnnotation()

Creates a line annotation to be added to an AnnotationOptions instance.

LineAnnotation

public LineAnnotation(IsChart chart)

Creates a line annotation to be added to an AnnotationOptions instance, relating to chart instance for default.

Parameters:

chart - chart instance related to the plugin options

Method Detail

getLabel

public LineLabel getLabel()

Returns the label on the line.

Returns:

the label on the line

getBorderColorAsString

public String getBorderColorAsString()

Returns the color of the border of annotation.

Returns:

the color of the border of annotation

getBorderWidth

public int getBorderWidth()

Returns the width of the border in pixels.

Returns:

the width of the border in pixels.

setBorderDash

public void setBorderDash(int... borderDash)

Sets the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.

Parameters:

borderDash - the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.

getBorderDash

public List<Integer> getBorderDash()

Returns the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.

Returns:

the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.

setBorderDashOffset

public void setBorderDashOffset(int borderDashOffset)

Sets the line dash pattern offset or "phase".

Parameters:

borderDashOffset - the line dash pattern offset or "phase".

getBorderDashOffset

public int getBorderDashOffset()

Returns the line dash pattern offset or "phase".

Returns:

the line dash pattern offset or "phase".

setMode

public void setMode(LineMode mode)

Sets the orientation (horizontal or vertical) of the line.

Parameters:

mode - the orientation (horizontal or vertical) of the line

getMode

public LineMode getMode()

Returns the orientation (horizontal or vertical) of the line.

Returns:

the orientation (horizontal or vertical) of the line

setScaleID

public void setScaleID(String scaleId)

Sets the ID of the scale to bind onto.

Parameters:

scaleId - the ID of the scale to bind onto

getScaleID

public String getScaleID()

Returns the ID of the scale to bind onto.

Returns:

the ID of the scale to bind onto

setValue

public void setValue(String value)

Sets the data value to draw the line at.

Parameters:

value - the data value to draw the line at

setValue

public void setValue(double value)

Sets the data value to draw the line at.

Parameters:

value - the data value to draw the line at

setValue

public void setValue(Date value)

Sets the data value to draw the line at.

Parameters:

value - the data value to draw the line at

getValueAsString

public String getValueAsString()

Returns the data value to draw the line at.

Returns:

the data value to draw the line at

getValueAsDouble

public double getValueAsDouble()

Returns the data value to draw the line at.

Returns:

the data value to draw the line at

getValueAsDate

public Date getValueAsDate()

Returns the data value to draw the line at.

Returns:

the data value to draw the line at

setEndValue

public void setEndValue(String endValue)

Sets the data value at which the line draw should end.

Parameters:

endValue - the data value at which the line draw should end

setEndValue

public void setEndValue(double endValue)

Sets the data value at which the line draw should end.

Parameters:

endValue - the data value at which the line draw should end

setEndValue

public void setEndValue(Date endValue)

Sets the data value at which the line draw should end.

Parameters:

endValue - the data value at which the line draw should end

getEndValueAsString

public String getEndValueAsString()

Returns the data value at which the line draw should end.

Returns:

the data value at which the line draw should end

getEndValueAsDouble

public double getEndValueAsDouble()

Returns the data value at which the line draw should end.

Returns:

the data value at which the line draw should end

getEndValueAsDate

public Date getEndValueAsDate()

Returns the data value at which the line draw should end.

Returns:

the data value at which the line draw should end