org.pepstock.charba.client.annotation

Class BoxAnnotation

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.BoxAnnotation

public final class BoxAnnotation
extends AbstractAnnotation

Implements a BOX annotation which draws a box into a chart.
If one of the axes is not specified, the box will take the entire chart dimension.
The 4 coordinates, xMin, xMax, yMin, yMax are optional. If not specified, the box is expanded out to the edges.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static IsColor	DEFAULT_BACKGROUND_COLOR Default box annotation background color, rgb(102, 102, 102).
static String	DEFAULT_BACKGROUND_COLOR_AS_STRING Default box annotation background color as string, rgb(102, 102, 102).
static IsColor	DEFAULT_BORDER_COLOR Default box annotation border color, rgb(92, 92, 92).
static String	DEFAULT_BORDER_COLOR_AS_STRING Default box annotation border color as string, rgb(92, 92, 92).
static int	DEFAULT_BORDER_WIDTH Default box annotation border width, 1.
static String	DEFAULT_ID Default box annotation ID, "a-box-1".

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
IsColor	getBackgroundColor() Returns the color of the background of annotation.
String	getBackgroundColorAsString() Returns the color of the background of annotation.
String	getBorderColorAsString() Returns the color of the border of annotation.
int	getBorderWidth() Returns the width of the border in pixels.
Date	getXMaxAsDate() Returns the right edge of the box.
double	getXMaxAsDouble() Returns the right edge of the box.
String	getXMaxAsString() Returns the right edge of the box.
Date	getXMinAsDate() Returns the left edge of the box, in units along the x axis.
double	getXMinAsDouble() Returns the left edge of the box, in units along the x axis.
String	getXMinAsString() Returns the left edge of the box, in units along the x axis.
String	getXScaleID() Returns the ID of the X scale to bind onto.
Date	getYMaxAsDate() Returns the top edge of the box in units along the y axis.
double	getYMaxAsDouble() Returns the top edge of the box in units along the y axis.
String	getYMaxAsString() Returns the top edge of the box in units along the y axis.
Date	getYMinAsDate() Returns the bottom edge of the box.
double	getYMinAsDouble() Returns the bottom edge of the box.
String	getYMinAsString() Returns the bottom edge of the box.
String	getYScaleID() Returns the ID of the Y scale to bind onto.
void	setBackgroundColor(IsColor backgroundColor) Sets the color of the background of annotation.
void	setBackgroundColor(String backgroundColor) Sets the color of the background of annotation.
void	setXMax(Date max) Sets the right edge of the box.
void	setXMax(double max) Sets the right edge of the box.
void	setXMax(String max) Sets the right edge of the box.
void	setXMin(Date min) Sets the left edge of the box, in units along the x axis.
void	setXMin(double min) Sets the left edge of the box, in units along the x axis.
void	setXMin(String min) Sets the left edge of the box, in units along the x axis.
void	setXScaleID(String scaleId) Sets the ID of the X scale to bind onto.
void	setYMax(Date max) Sets the top edge of the box in units along the y axis.
void	setYMax(double max) Sets the top edge of the box in units along the y axis.
void	setYMax(String max) Sets the top edge of the box in units along the y axis.
void	setYMin(Date min) Sets the bottom edge of the box.
void	setYMin(double min) Sets the bottom edge of the box.
void	setYMin(String min) Sets the bottom edge of the box.
void	setYScaleID(String scaleId) Sets the ID of the Y scale to bind onto.

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, getNativeChart, 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, setArrayValue, setValue, 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 box annotation ID, "a-box-1".

See Also:

Constant Field Values

DEFAULT_BACKGROUND_COLOR

public static final IsColor DEFAULT_BACKGROUND_COLOR

Default box annotation background color, rgb(102, 102, 102).

DEFAULT_BACKGROUND_COLOR_AS_STRING

public static final String DEFAULT_BACKGROUND_COLOR_AS_STRING

Default box annotation background color as string, rgb(102, 102, 102).

DEFAULT_BORDER_COLOR

public static final IsColor DEFAULT_BORDER_COLOR

Default box annotation border color, rgb(92, 92, 92).

DEFAULT_BORDER_COLOR_AS_STRING

public static final String DEFAULT_BORDER_COLOR_AS_STRING

Default box annotation border color as string, rgb(92, 92, 92).

DEFAULT_BORDER_WIDTH

public static final int DEFAULT_BORDER_WIDTH

Default box annotation border width, 1.

See Also:

Constant Field Values

Constructor Detail

BoxAnnotation

public BoxAnnotation()

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

BoxAnnotation

public BoxAnnotation(IsChart chart)

Creates a box 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

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.

setBackgroundColor

public void setBackgroundColor(IsColor backgroundColor)

Sets the color of the background of annotation.

Parameters:

backgroundColor - the color of the background of annotation

setBackgroundColor

public void setBackgroundColor(String backgroundColor)

Sets the color of the background of annotation.

Parameters:

backgroundColor - the color of the background of annotation

getBackgroundColorAsString

public String getBackgroundColorAsString()

Returns the color of the background of annotation.

Returns:

the color of the background of annotation

getBackgroundColor

public IsColor getBackgroundColor()

Returns the color of the background of annotation.

Returns:

the color of the background of annotation

setXScaleID

public void setXScaleID(String scaleId)

Sets the ID of the X scale to bind onto.

Parameters:

scaleId - the ID of the X scale to bind onto

getXScaleID

public String getXScaleID()

Returns the ID of the X scale to bind onto.

Returns:

the ID of the X scale to bind onto

setXMax

public void setXMax(String max)

Sets the right edge of the box.

Parameters:

max - the right edge of the box

setXMax

public void setXMax(double max)

Sets the right edge of the box.

Parameters:

max - the right edge of the box

setXMax

public void setXMax(Date max)

Sets the right edge of the box.

Parameters:

max - the right edge of the box

getXMaxAsString

public String getXMaxAsString()

Returns the right edge of the box.

Returns:

the right edge of the box

getXMaxAsDouble

public double getXMaxAsDouble()

Returns the right edge of the box.

Returns:

the right edge of the box

getXMaxAsDate

public Date getXMaxAsDate()

Returns the right edge of the box.

Returns:

the right edge of the box

setXMin

public void setXMin(String min)

Sets the left edge of the box, in units along the x axis.

Parameters:

min - the left edge of the box

setXMin

public void setXMin(double min)

Sets the left edge of the box, in units along the x axis.

Parameters:

min - the left edge of the box

setXMin

public void setXMin(Date min)

Sets the left edge of the box, in units along the x axis.

Parameters:

min - the left edge of the box

getXMinAsString

public String getXMinAsString()

Returns the left edge of the box, in units along the x axis.

Returns:

the left edge of the box

getXMinAsDouble

public double getXMinAsDouble()

Returns the left edge of the box, in units along the x axis.

Returns:

the left edge of the box

getXMinAsDate

public Date getXMinAsDate()

Returns the left edge of the box, in units along the x axis.

Returns:

the left edge of the box

setYScaleID

public void setYScaleID(String scaleId)

Sets the ID of the Y scale to bind onto.

Parameters:

scaleId - the ID of the Y scale to bind onto

getYScaleID

public String getYScaleID()

Returns the ID of the Y scale to bind onto.

Returns:

the ID of the Y scale to bind onto

setYMax

public void setYMax(String max)

Sets the top edge of the box in units along the y axis.

Parameters:

max - the top edge of the box in units along the y axis

setYMax

public void setYMax(double max)

Sets the top edge of the box in units along the y axis.

Parameters:

max - the top edge of the box in units along the y axis

setYMax

public void setYMax(Date max)

Sets the top edge of the box in units along the y axis.

Parameters:

max - the top edge of the box in units along the y axis

getYMaxAsString

public String getYMaxAsString()

Returns the top edge of the box in units along the y axis.

Returns:

the top edge of the box in units along the y axis

getYMaxAsDouble

public double getYMaxAsDouble()

Returns the top edge of the box in units along the y axis.

Returns:

the top edge of the box in units along the y axis

getYMaxAsDate

public Date getYMaxAsDate()

Returns the top edge of the box in units along the y axis.

Returns:

the top edge of the box in units along the y axis

setYMin

public void setYMin(String min)

Sets the bottom edge of the box.

Parameters:

min - the bottom edge of the box

setYMin

public void setYMin(double min)

Sets the bottom edge of the box.

Parameters:

min - the bottom edge of the box

setYMin

public void setYMin(Date min)

Sets the bottom edge of the box.

Parameters:

min - the bottom edge of the box

getYMinAsString

public String getYMinAsString()

Returns the bottom edge of the box.

Returns:

the bottom edge of the box

getYMinAsDouble

public double getYMinAsDouble()

Returns the bottom edge of the box.

Returns:

the bottom edge of the box

getYMinAsDate

public Date getYMinAsDate()

Returns the bottom edge of the box.

Returns:

the bottom edge of the box