java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.commons.AbstractNode
  - - 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 in the 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	Description
`static int`	`DEFAULT_BORDER_RADIUS`	Default box annotation border radius, 0.
`static int`	`DEFAULT_BORDER_WIDTH`	Default box annotation border width, 1.

Fields inherited from class org.pepstock.charba.client.annotation.AbstractAnnotation
DEFAULT_ADJUST_SCALE_RANGE, DEFAULT_DISPLAY

Constructor Summary

Constructors
Constructor	Description
`BoxAnnotation()`	Creates a box annotation to be added to an `AnnotationOptions` instance. The annotation id is calculated automatically.
`BoxAnnotation(String id)`	Creates a box annotation to be added to an `AnnotationOptions` instance, using the ID passed as argument.
`BoxAnnotation(String id, IsChart chart)`	Creates a box annotation to be added to an `AnnotationOptions` instance, using the ID passed as argument. The chart instance, passed as argument, must be the chart where the annotations will be applied and is used to get the whole default options in order to get the default for this object.
`BoxAnnotation(AnnotationId id)`	Creates a box annotation to be added to an `AnnotationOptions` instance, using the ID passed as argument.
`BoxAnnotation(AnnotationId id, IsChart chart)`	Creates a box annotation to be added to an `AnnotationOptions` instance, using the ID passed as argument. The chart instance, passed as argument, must be the chart where the annotations will be applied and is used to get the whole default options in order to get the default for this object.

Method Summary

All Methods Instance Methods Concrete Methods Default Methods
Modifier and Type	Method	Description
`default AdjustScaleRangeCallback`	`getAdjustScaleRangeCallback()`	Returns the callback called to set whether the scale range should be adjusted if this annotation is out of range.
`default IsColor`	`getBackgroundColor()`	Returns the color of the background of annotation.
`default String`	`getBackgroundColorAsString()`	Returns the color of the background of annotation.
`default ColorCallback<AnnotationContext>`	`getBackgroundColorCallback()`	Returns the callback called to set the color of the background of annotation.
`org.pepstock.charba.client.annotation.BackgroundColorHandler`	`getBackgroundColorHandler()`
`String`	`getBorderColorAsString()`	Returns the color of the border of annotation.
`default ColorCallback<AnnotationContext>`	`getBorderColorCallback()`	Returns the callback called to set the color of the border of annotation.
`default 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.
`default BorderDashCallback<AnnotationContext>`	`getBorderDashCallback()`	Returns the callback called to set 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.
`default double`	`getBorderDashOffset()`	Returns the line dash pattern offset.
`default BorderDashOffsetCallback<AnnotationContext>`	`getBorderDashOffsetCallback()`	Returns the callback called to set the line dash pattern offset.
`default int`	`getBorderRadius()`	Returns the border radius (in pixels).
`default BarBorderRadius`	`getBorderRadiusAsObject()`	Returns the border radius (in pixels).
`default BorderRadiusCallback<AnnotationContext>`	`getBorderRadiusCallback()`	Returns the callback called to set the border radius.
`org.pepstock.charba.client.annotation.BorderRadiusHandler`	`getBorderRadiusHandler()`
`int`	`getBorderWidth()`	Returns the width of the border in pixels.
`default WidthCallback<AnnotationContext>`	`getBorderWidthCallback()`	Returns the callback called to set the width of the border in pixels.
`default ClickCallback`	`getClickCallback()`	Returns the callback called when a "click" event is occurring.
`default DisplayCallback<AnnotationContext>`	`getDisplayCallback()`	Returns the callback called to set the display options.
`default DoubleClickCallback`	`getDoubleClickCallback()`	Returns the callback called when a "dblclick" event is occurring.
`default DrawTime`	`getDrawTime()`	Returns the draw time which defines when the annotations are drawn.
`default DrawTimeCallback`	`getDrawTimeCallback()`	Returns the callback called to set the draw time which defines when the annotations are drawn.
`default EnterCallback`	`getEnterCallback()`	Returns the callback called when a "enter" event is occurring.
`default LeaveCallback`	`getLeaveCallback()`	Returns the callback called when a "leave" event is occurring.
`default AnnotationType`	`getType()`
`Date`	`getXMaxAsDate()`	Returns the right edge of the box.
`default Date`	`getXMaxAsDate()`	Returns the right edge of the box.
`double`	`getXMaxAsDouble()`	Returns the right edge of the box.
`default double`	`getXMaxAsDouble()`	Returns the right edge of the box.
`String`	`getXMaxAsString()`	Returns the right edge of the box.
`default String`	`getXMaxAsString()`	Returns the right edge of the box.
`ValueCallback`	`getXMaxCallback()`	Returns the callback called to set the right edge of the box.
`default ValueCallback`	`getXMaxCallback()`	Returns the callback called to set the right edge of the box.
`Date`	`getXMinAsDate()`	Returns the left edge of the box, in units along the x axis.
`default 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.
`default 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.
`default String`	`getXMinAsString()`	Returns the left edge of the box, in units along the x axis.
`ValueCallback`	`getXMinCallback()`	Returns the callback called to set the left edge of the box, in units along the x axis.
`default ValueCallback`	`getXMinCallback()`	Returns the callback called to set the left edge of the box, in units along the x axis.
`ScaleId`	`getXScaleID()`	Returns the ID of the X scale to bind onto.
`default ScaleId`	`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.
`default 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.
`default 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.
`default String`	`getYMaxAsString()`	Returns the top edge of the box in units along the y axis.
`ValueCallback`	`getYMaxCallback()`	Returns the callback called to set the top edge of the box in units along the y axis.
`default ValueCallback`	`getYMaxCallback()`	Returns the callback called to set the right edge of the box.
`Date`	`getYMinAsDate()`	Returns the bottom edge of the box.
`default Date`	`getYMinAsDate()`	Returns the bottom edge of the box.
`double`	`getYMinAsDouble()`	Returns the bottom edge of the box.
`default double`	`getYMinAsDouble()`	Returns the bottom edge of the box.
`String`	`getYMinAsString()`	Returns the bottom edge of the box.
`default String`	`getYMinAsString()`	Returns the bottom edge of the box.
`ValueCallback`	`getYMinCallback()`	Returns the callback called to set the bottom edge of the box.
`default ValueCallback`	`getYMinCallback()`	Returns the callback called to set the left edge of the box, in units along the x axis.
`ScaleId`	`getYScaleID()`	Returns the ID of the Y scale to bind onto.
`default ScaleId`	`getYScaleID()`	Returns the ID of the Y scale to bind onto.
`default boolean`	`isAdjustScaleRange()`	Returns `true` whether the scale range should be adjusted if this annotation is out of range.
`default boolean`	`isDisplay()`	Returns `true` whether the annotation should be displayed.
`default void`	`setBackgroundColor(String backgroundColor)`	Sets the color of the background of annotation.
`default void`	`setBackgroundColor(ColorCallback<AnnotationContext> backgroundColorCallback)`	Sets the callback to set the color of the background of annotation.
`default void`	`setBackgroundColor(NativeCallback backgroundColorCallback)`	Sets the callback to set the color of the background of annotation.
`default void`	`setBackgroundColor(IsColor backgroundColor)`	Sets the color of the background of annotation.
`default void`	`setBorderRadius(int radius)`	Sets the border radius.
`default void`	`setBorderRadius(BorderRadiusCallback<AnnotationContext> borderRadiusCallback)`	Sets the callback to set the border radius.
`default void`	`setBorderRadius(NativeCallback borderRadiusCallback)`	Sets the callback to set the border radius.
`default void`	`setBorderRadius(BarBorderRadius borderRadius)`	Sets the border radius (in pixels).
`void`	`setXMax(double max)`	Sets the right edge of the box.
`void`	`setXMax(String max)`	Sets the right edge of the box.
`void`	`setXMax(Date max)`	Sets the right edge of the box.
`void`	`setXMax(ValueCallback valueCallback)`	Sets the callback to set the right edge of the box.
`void`	`setXMax(NativeCallback valueCallback)`	Sets the callback to set the right edge of the box.
`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`	`setXMin(Date min)`	Sets the left edge of the box, in units along the x axis.
`void`	`setXMin(ValueCallback valueCallback)`	Sets the callback to set the left edge of the box, in units along the x axis.
`void`	`setXMin(NativeCallback valueCallback)`	Sets the callback to set 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`	`setXScaleID(ScaleId scaleId)`	Sets the ID of the X scale to bind onto.
`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`	`setYMax(Date max)`	Sets the top edge of the box in units along the y axis.
`void`	`setYMax(ValueCallback valueCallback)`	Sets the callback to set the top edge of the box in units along the y axis.
`void`	`setYMax(NativeCallback valueCallback)`	Sets the callback to set the top edge of the box in units along the y axis.
`void`	`setYMin(double min)`	Sets the bottom edge of the box.
`void`	`setYMin(String min)`	Sets the bottom edge of the box.
`void`	`setYMin(Date min)`	Sets the bottom edge of the box.
`void`	`setYMin(ValueCallback valueCallback)`	Sets the callback to set the bottom edge of the box.
`void`	`setYMin(NativeCallback valueCallback)`	Sets the callback to set the bottom edge of the box.
`void`	`setYScaleID(String scaleId)`	Sets the ID of the Y scale to bind onto.
`void`	`setYScaleID(ScaleId scaleId)`	Sets the ID of the Y scale to bind onto.

Methods inherited from class org.pepstock.charba.client.annotation.AbstractAnnotation
getAdjustScaleRangeCallback, getBorderColor, getBorderColorCallback, getBorderDash, getBorderDashCallback, getBorderDashOffset, getBorderDashOffsetCallback, getBorderWidthCallback, getClickCallback, getDisplayCallback, getDoubleClickCallback, getDrawTime, getDrawTimeCallback, getEnterCallback, getId, getLeaveCallback, getType, isAdjustScaleRange, isDisplay, setAdjustScaleRange, setAdjustScaleRange, setAdjustScaleRange, setBorderColor, setBorderColor, setBorderColor, setBorderColor, setBorderDash, setBorderDash, setBorderDash, setBorderDashOffset, setBorderDashOffset, setBorderDashOffset, setBorderWidth, setBorderWidth, setBorderWidth, setClickCallback, setDisplay, setDisplay, setDisplay, setDoubleClickCallback, setDrawTime, setDrawTime, setDrawTime, setEnterCallback, setLeaveCallback

Methods inherited from class org.pepstock.charba.client.commons.AbstractNode
checkAndAddToParent, getChildKey, getParentNode, getRootNode, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer
checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, 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_BORDER_WIDTH
```
public static final int DEFAULT_BORDER_WIDTH
```
    Default box annotation border width, 1.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BORDER_RADIUS
```
public static final int DEFAULT_BORDER_RADIUS
```
    Default box annotation border radius, 0.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BoxAnnotation
```
public BoxAnnotation()
```
    Creates a box annotation to be added to an AnnotationOptions instance.
    The annotation id is calculated automatically.
    
    See Also:
    
    AnnotationType.createId()
  - BoxAnnotation
```
public BoxAnnotation(String id)
```
    Creates a box annotation to be added to an AnnotationOptions instance, using the ID passed as argument.
    
    Parameters:
    
    id - annotation id to apply to the object, as string
  - BoxAnnotation
```
public BoxAnnotation(AnnotationId id)
```
    Creates a box annotation to be added to an AnnotationOptions instance, using the ID passed as argument.
    
    Parameters:
    
    id - annotation id to apply to the object
  - BoxAnnotation
```
public BoxAnnotation(String id,
                     IsChart chart)
```
    Creates a box annotation to be added to an AnnotationOptions instance, using the ID passed as argument.
    The chart instance, passed as argument, must be the chart where the annotations will be applied and is used to get the whole default options in order to get the default for this object.
    
    Parameters:
    
    id - annotation id to apply to the object, as string
    
    chart - chart instance related to the plugin options
  - BoxAnnotation
```
public BoxAnnotation(AnnotationId id,
                     IsChart chart)
```
    Creates a box annotation to be added to an AnnotationOptions instance, using the ID passed as argument.
    The chart instance, passed as argument, must be the chart where the annotations will be applied and is used to get the whole default options in order to get the default for this object.
    
    Parameters:
    
    id - annotation id to apply to the object
    
    chart - chart instance related to the plugin options
- Method Detail
  - getBackgroundColorHandler
```
public org.pepstock.charba.client.annotation.BackgroundColorHandler getBackgroundColorHandler()
```
  - getBorderRadiusHandler
```
public org.pepstock.charba.client.annotation.BorderRadiusHandler getBorderRadiusHandler()
```
  - getBorderColorAsString
```
public final String getBorderColorAsString()
```
    Returns the color of the border of annotation.
    
    Returns:
    
    the color of the border of annotation
  - getBorderWidth
```
public final int getBorderWidth()
```
    Returns the width of the border in pixels.
    
    Returns:
    
    the width of the border in pixels.
  - getType
```
public default AnnotationType getType()
```
  - getXScaleID
```
public default ScaleId getXScaleID()
```
    Returns the ID of the X scale to bind onto.
    
    Returns:
    
    the ID of the X scale to bind onto
  - getXMaxAsString
```
public default String getXMaxAsString()
```
    Returns the right edge of the box.
    
    Returns:
    
    the right edge of the box
  - getXMaxAsDouble
```
public default double getXMaxAsDouble()
```
    Returns the right edge of the box.
    
    Returns:
    
    the right edge of the box
  - getXMaxAsDate
```
public default Date getXMaxAsDate()
```
    Returns the right edge of the box.
    
    Returns:
    
    the right edge of the box
  - getXMinAsString
```
public default String getXMinAsString()
```
    Returns the left edge of the box, in units along the x axis.
    
    Returns:
    
    the left edge of the box
  - getXMinAsDouble
```
public default double getXMinAsDouble()
```
    Returns the left edge of the box, in units along the x axis.
    
    Returns:
    
    the left edge of the box
  - getXMinAsDate
```
public default Date getXMinAsDate()
```
    Returns the left edge of the box, in units along the x axis.
    
    Returns:
    
    the left edge of the box
  - getYScaleID
```
public default ScaleId getYScaleID()
```
    Returns the ID of the Y scale to bind onto.
    
    Returns:
    
    the ID of the Y scale to bind onto
  - getYMaxAsString
```
public default 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 default 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 default 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
  - getYMinAsString
```
public default String getYMinAsString()
```
    Returns the bottom edge of the box.
    
    Returns:
    
    the bottom edge of the box
  - getYMinAsDouble
```
public default double getYMinAsDouble()
```
    Returns the bottom edge of the box.
    
    Returns:
    
    the bottom edge of the box
  - getYMinAsDate
```
public default Date getYMinAsDate()
```
    Returns the bottom edge of the box.
    
    Returns:
    
    the bottom edge of the box
  - getXMinCallback
```
public default ValueCallback getXMinCallback()
```
    Returns the callback called to set the left edge of the box, in units along the x axis.
    
    Returns:
    
    the callback called to set the left edge of the box, in units along the x axis
  - getXMaxCallback
```
public default ValueCallback getXMaxCallback()
```
    Returns the callback called to set the right edge of the box.
    
    Returns:
    
    the callback called to set the right edge of the box
  - getYMinCallback
```
public default ValueCallback getYMinCallback()
```
    Returns the callback called to set the left edge of the box, in units along the x axis.
    
    Returns:
    
    the callback called to set the left edge of the box, in units along the x axis
  - getYMaxCallback
```
public default ValueCallback getYMaxCallback()
```
    Returns the callback called to set the right edge of the box.
    
    Returns:
    
    the callback called to set the right edge of the box
  - isDisplay
```
public default boolean isDisplay()
```
    Returns true whether the annotation should be displayed.
    
    Returns:
    
    true whether the annotation should be displayed
  - isAdjustScaleRange
```
public default boolean isAdjustScaleRange()
```
    Returns true whether the scale range should be adjusted if this annotation is out of range.
    
    Returns:
    
    true whether the scale range should be adjusted if this annotation is out of range
  - getDrawTime
```
public default DrawTime getDrawTime()
```
    Returns the draw time which defines when the annotations are drawn.
    
    Returns:
    
    the draw time which defines when the annotations are drawn
  - getBorderDash
```
public default 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
  - getBorderDashOffset
```
public default double getBorderDashOffset()
```
    Returns the line dash pattern offset.
    
    Returns:
    
    the line dash pattern offset
  - getEnterCallback
```
public default EnterCallback getEnterCallback()
```
    Returns the callback called when a "enter" event is occurring.
    
    Returns:
    
    the callback called when a "enter" event is occurring
  - getLeaveCallback
```
public default LeaveCallback getLeaveCallback()
```
    Returns the callback called when a "leave" event is occurring.
    
    Returns:
    
    the callback called when a "leave" event is occurring
  - getClickCallback
```
public default ClickCallback getClickCallback()
```
    Returns the callback called when a "click" event is occurring.
    
    Returns:
    
    the callback called when a "click" event is occurring
  - getDoubleClickCallback
```
public default DoubleClickCallback getDoubleClickCallback()
```
    Returns the callback called when a "dblclick" event is occurring.
    
    Returns:
    
    the callback called when a "dblclick" event is occurring
  - getDrawTimeCallback
```
public default DrawTimeCallback getDrawTimeCallback()
```
    Returns the callback called to set the draw time which defines when the annotations are drawn.
    
    Returns:
    
    the callback called to set the draw time which defines when the annotations are drawn
  - getDisplayCallback
```
public default DisplayCallback<AnnotationContext> getDisplayCallback()
```
    Returns the callback called to set the display options.
    
    Returns:
    
    the callback called to set the display options
  - getBorderColorCallback
```
public default ColorCallback<AnnotationContext> getBorderColorCallback()
```
    Returns the callback called to set the color of the border of annotation.
    
    Returns:
    
    the callback called to set the color of the border of annotation
  - getBorderWidthCallback
```
public default WidthCallback<AnnotationContext> getBorderWidthCallback()
```
    Returns the callback called to set the width of the border in pixels.
    
    Returns:
    
    the callback called to set the width of the border in pixels
  - getBorderDashCallback
```
public default BorderDashCallback<AnnotationContext> getBorderDashCallback()
```
    Returns the callback called to set 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 callback called to set 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
  - getBorderDashOffsetCallback
```
public default BorderDashOffsetCallback<AnnotationContext> getBorderDashOffsetCallback()
```
    Returns the callback called to set the line dash pattern offset.
    
    Returns:
    
    the callback called to set the line dash pattern offset
  - getAdjustScaleRangeCallback
```
public default AdjustScaleRangeCallback getAdjustScaleRangeCallback()
```
    Returns the callback called to set whether the scale range should be adjusted if this annotation is out of range.
    
    Returns:
    
    the callback called to set whether the scale range should be adjusted if this annotation is out of range
  - setBackgroundColor
```
public default void setBackgroundColor(IsColor backgroundColor)
```
    Sets the color of the background of annotation.
    
    Parameters:
    
    backgroundColor - the color of the background of annotation
  - setBackgroundColor
```
public default void setBackgroundColor(String backgroundColor)
```
    Sets the color of the background of annotation.
    
    Parameters:
    
    backgroundColor - the color of the background of annotation
  - getBackgroundColorAsString
```
public default String getBackgroundColorAsString()
```
    Returns the color of the background of annotation.
    
    Returns:
    
    the color of the background of annotation
  - getBackgroundColor
```
public default IsColor getBackgroundColor()
```
    Returns the color of the background of annotation.
    
    Returns:
    
    the color of the background of annotation
  - getBackgroundColorCallback
```
public default ColorCallback<AnnotationContext> getBackgroundColorCallback()
```
    Returns the callback called to set the color of the background of annotation.
    
    Returns:
    
    the callback called to set the color of the background of annotation
  - setBackgroundColor
```
public default void setBackgroundColor(ColorCallback<AnnotationContext> backgroundColorCallback)
```
    Sets the callback to set the color of the background of annotation.
    
    Parameters:
    
    backgroundColorCallback - to set the color of the background of annotation
  - setBackgroundColor
```
public default void setBackgroundColor(NativeCallback backgroundColorCallback)
```
    Sets the callback to set the color of the background of annotation.
    
    Parameters:
    
    backgroundColorCallback - to set the color of the background of annotation
  - setBorderRadius
```
public default void setBorderRadius(int radius)
```
    Sets the border radius.
    
    Parameters:
    
    radius - the border radius.
  - setBorderRadius
```
public default void setBorderRadius(BarBorderRadius borderRadius)
```
    Sets the border radius (in pixels).
    
    Parameters:
    
    borderRadius - the border radius (in pixels).
  - getBorderRadius
```
public default int getBorderRadius()
```
    Returns the border radius (in pixels).
    
    Returns:
    
    the border radius (in pixels).
  - getBorderRadiusAsObject
```
public default BarBorderRadius getBorderRadiusAsObject()
```
    Returns the border radius (in pixels).
    
    Returns:
    
    the border radius (in pixels).
  - getBorderRadiusCallback
```
public default BorderRadiusCallback<AnnotationContext> getBorderRadiusCallback()
```
    Returns the callback called to set the border radius.
    
    Returns:
    
    the callback called to set the border radius
  - setBorderRadius
```
public default void setBorderRadius(BorderRadiusCallback<AnnotationContext> borderRadiusCallback)
```
    Sets the callback to set the border radius.
    
    Parameters:
    
    borderRadiusCallback - to set the border radius
  - setBorderRadius
```
public default void setBorderRadius(NativeCallback borderRadiusCallback)
```
    Sets the callback to set the border radius.
    
    Parameters:
    
    borderRadiusCallback - to set the border radius
  - setXScaleID
```
public final 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
  - setXScaleID
```
public final void setXScaleID(ScaleId scaleId)
```
    Sets the ID of the X scale to bind onto.
    
    Parameters:
    
    scaleId - the ID of the X scale to bind onto
  - getXScaleID
```
public final ScaleId getXScaleID()
```
    Returns the ID of the X scale to bind onto.
    
    Returns:
    
    the ID of the X scale to bind onto
  - setXMax
```
public final void setXMax(String max)
```
    Sets the right edge of the box.
    
    Parameters:
    
    max - the right edge of the box
  - setXMax
```
public final void setXMax(double max)
```
    Sets the right edge of the box.
    
    Parameters:
    
    max - the right edge of the box
  - setXMax
```
public final void setXMax(Date max)
```
    Sets the right edge of the box.
    
    Parameters:
    
    max - the right edge of the box
  - getXMaxAsString
```
public final String getXMaxAsString()
```
    Returns the right edge of the box.
    
    Returns:
    
    the right edge of the box
  - getXMaxAsDouble
```
public final double getXMaxAsDouble()
```
    Returns the right edge of the box.
    
    Returns:
    
    the right edge of the box
  - getXMaxAsDate
```
public final Date getXMaxAsDate()
```
    Returns the right edge of the box.
    
    Returns:
    
    the right edge of the box
  - setXMin
```
public final 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 final 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 final 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 final String getXMinAsString()
```
    Returns the left edge of the box, in units along the x axis.
    
    Returns:
    
    the left edge of the box
  - getXMinAsDouble
```
public final double getXMinAsDouble()
```
    Returns the left edge of the box, in units along the x axis.
    
    Returns:
    
    the left edge of the box
  - getXMinAsDate
```
public final Date getXMinAsDate()
```
    Returns the left edge of the box, in units along the x axis.
    
    Returns:
    
    the left edge of the box
  - setYScaleID
```
public final 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
  - setYScaleID
```
public final void setYScaleID(ScaleId scaleId)
```
    Sets the ID of the Y scale to bind onto.
    
    Parameters:
    
    scaleId - the ID of the Y scale to bind onto
  - getYScaleID
```
public final ScaleId getYScaleID()
```
    Returns the ID of the Y scale to bind onto.
    
    Returns:
    
    the ID of the Y scale to bind onto
  - setYMax
```
public final 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 final 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 final 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 final 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 final 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 final 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 final void setYMin(String min)
```
    Sets the bottom edge of the box.
    
    Parameters:
    
    min - the bottom edge of the box
  - setYMin
```
public final void setYMin(double min)
```
    Sets the bottom edge of the box.
    
    Parameters:
    
    min - the bottom edge of the box
  - setYMin
```
public final void setYMin(Date min)
```
    Sets the bottom edge of the box.
    
    Parameters:
    
    min - the bottom edge of the box
  - getYMinAsString
```
public final String getYMinAsString()
```
    Returns the bottom edge of the box.
    
    Returns:
    
    the bottom edge of the box
  - getYMinAsDouble
```
public final double getYMinAsDouble()
```
    Returns the bottom edge of the box.
    
    Returns:
    
    the bottom edge of the box
  - getYMinAsDate
```
public final Date getYMinAsDate()
```
    Returns the bottom edge of the box.
    
    Returns:
    
    the bottom edge of the box
  - getXMinCallback
```
public final ValueCallback getXMinCallback()
```
    Returns the callback called to set the left edge of the box, in units along the x axis.
    
    Returns:
    
    the callback called to set the left edge of the box, in units along the x axis
  - setXMin
```
public final void setXMin(ValueCallback valueCallback)
```
    Sets the callback to set the left edge of the box, in units along the x axis.
    
    Parameters:
    
    valueCallback - to set the left edge of the box, in units along the x axis
  - setXMin
```
public final void setXMin(NativeCallback valueCallback)
```
    Sets the callback to set the left edge of the box, in units along the x axis.
    
    Parameters:
    
    valueCallback - to set the left edge of the box, in units along the x axis
  - getXMaxCallback
```
public final ValueCallback getXMaxCallback()
```
    Returns the callback called to set the right edge of the box.
    
    Returns:
    
    the callback called to set the right edge of the box
  - setXMax
```
public final void setXMax(ValueCallback valueCallback)
```
    Sets the callback to set the right edge of the box.
    
    Parameters:
    
    valueCallback - to set the right edge of the box
  - setXMax
```
public final void setXMax(NativeCallback valueCallback)
```
    Sets the callback to set the right edge of the box.
    
    Parameters:
    
    valueCallback - to set the right edge of the box
  - getYMinCallback
```
public final ValueCallback getYMinCallback()
```
    Returns the callback called to set the bottom edge of the box.
    
    Returns:
    
    the callback called to set the bottom edge of the box
  - setYMin
```
public final void setYMin(ValueCallback valueCallback)
```
    Sets the callback to set the bottom edge of the box.
    
    Parameters:
    
    valueCallback - to set the bottom edge of the box
  - setYMin
```
public final void setYMin(NativeCallback valueCallback)
```
    Sets the callback to set the bottom edge of the box.
    
    Parameters:
    
    valueCallback - to set the bottom edge of the box
  - getYMaxCallback
```
public final ValueCallback getYMaxCallback()
```
    Returns the callback called to set the top edge of the box in units along the y axis.
    
    Returns:
    
    the callback called to set the top edge of the box in units along the y axis
  - setYMax
```
public final void setYMax(ValueCallback valueCallback)
```
    Sets the callback to set the top edge of the box in units along the y axis.
    
    Parameters:
    
    valueCallback - to set the top edge of the box in units along the y axis
  - setYMax
```
public final void setYMax(NativeCallback valueCallback)
```
    Sets the callback to set the top edge of the box in units along the y axis.
    
    Parameters:
    
    valueCallback - to set the top edge of the box in units along the y axis

Class BoxAnnotation

Field Summary

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BORDER_WIDTH

DEFAULT_BORDER_RADIUS

Constructor Detail

BoxAnnotation

BoxAnnotation

BoxAnnotation

BoxAnnotation

BoxAnnotation

Method Detail

getBackgroundColorHandler

getBorderRadiusHandler

getBorderColorAsString

getBorderWidth

getType

getXScaleID

getXMaxAsString

getXMaxAsDouble

getXMaxAsDate

getXMinAsString

getXMinAsDouble

getXMinAsDate

getYScaleID

getYMaxAsString

getYMaxAsDouble

getYMaxAsDate

getYMinAsString

getYMinAsDouble

getYMinAsDate

getXMinCallback

getXMaxCallback

getYMinCallback

getYMaxCallback

isDisplay

isAdjustScaleRange

getDrawTime

getBorderDash

getBorderDashOffset

getEnterCallback

getLeaveCallback

getClickCallback

getDoubleClickCallback

getDrawTimeCallback

getDisplayCallback

getBorderColorCallback

getBorderWidthCallback

getBorderDashCallback

getBorderDashOffsetCallback

getAdjustScaleRangeCallback

setBackgroundColor

setBackgroundColor

getBackgroundColorAsString

getBackgroundColor

getBackgroundColorCallback

setBackgroundColor

setBackgroundColor

setBorderRadius

setBorderRadius

getBorderRadius

getBorderRadiusAsObject

getBorderRadiusCallback

setBorderRadius

setBorderRadius

setXScaleID

setXScaleID

getXScaleID

setXMax

setXMax

setXMax

getXMaxAsString

getXMaxAsDouble