java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.commons.AbstractNode
  - - org.pepstock.charba.client.annotation.AbstractAnnotation

Direct Known Subclasses:

BoxAnnotation, EllipseAnnotation, LabelAnnotation, LineAnnotation, PointAnnotation, PolygonAnnotation
```
public abstract class AbstractAnnotation
extends AbstractNode
```
Base class to define an annotation in the AnnotationPlugin.ID plugin.
It contains all commons properties to define an annotation.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields
Modifier and Type	Field	Description
`static boolean`	`DEFAULT_ADJUST_SCALE_RANGE`	Default annotation adjust scale range, true.
`static boolean`	`DEFAULT_DISPLAY`	Default annotation display, true.
`static boolean`	`DEFAULT_INIT`	Default annotation animation initialization, false.
`static double`	`DEFAULT_ROTATION`	Default annotation rotation, 0.0.
`static int`	`DEFAULT_Z`	Default annotation Z, 0.

Method Summary

All Methods Instance Methods Concrete Methods Default Methods
Modifier and Type	Method	Description
`AdjustScaleRangeCallback`	`getAdjustScaleRangeCallback()`	Returns the callback called to set whether the scale range should be adjusted if this annotation is out of range.
`ElementHookCallback`	`getAfterDrawCallback()`	Returns the callback called to get the control after the annotation element drawing.
`ElementHookCallback`	`getBeforeDrawCallback()`	Returns the callback called to get the control before the annotation element drawing.
`default IsColor`	`getBorderColor()`	Returns the color of the border of annotation.
`default 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.
`org.pepstock.charba.client.annotation.BorderOptionsHandler`	`getBorderOptionsHandler()`
`default IsColor`	`getBorderShadowColor()`	Returns the color of the border shadow of annotation.
`default String`	`getBorderShadowColorAsString()`	Returns the color of the border shadow of annotation.
`default ColorCallback<AnnotationContext>`	`getBorderShadowColorCallback()`	Returns the callback called to set the color of the border shadow of annotation.
`default 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.
`SimpleDisplayCallback<AnnotationContext>`	`getDisplayCallback()`	Returns the callback called to set whether the annotation should be displayed.
`DrawTime`	`getDrawTime()`	Returns the draw time which defines when the annotations are drawn.
`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.
`org.pepstock.charba.client.annotation.EventsHandler`	`getEventsHandler()`
`AnnotationId`	`getId()`	Returns the id of annotation.
`InitCallback`	`getInitCallback()`	Returns the callback called to get the control after the annotation element drawing.
`default LeaveCallback`	`getLeaveCallback()`	Returns the callback called when a "leave" event is occurring.
`default double`	`getShadowBlur()`	Returns the amount of blur applied to shadows.
`default ShadowBlurCallback`	`getShadowBlurCallback()`	Returns the callback called to set the amount of blur applied to shadows.
`default int`	`getShadowOffsetX()`	Returns the distance that shadows will be offset horizontally.
`default ShadowOffsetCallback`	`getShadowOffsetXCallback()`	Returns the callback called to set the distance that shadows will be offset horizontally.
`default int`	`getShadowOffsetY()`	Returns the distance that shadows will be offset vertically.
`default ShadowOffsetCallback`	`getShadowOffsetYCallback()`	Returns the callback called to set the distance that shadows will be offset vertically.
`org.pepstock.charba.client.annotation.ShadowOptionsHandler`	`getShadowOptionsHandler()`
`AnnotationType`	`getType()`	Returns the type of annotation.
`Date`	`getXMaxAsDate()`	Returns the right edge of the annotation.
`double`	`getXMaxAsDouble()`	Returns the right edge of the annotation.
`String`	`getXMaxAsString()`	Returns the right edge of the annotation.
`ValueCallback`	`getXMaxCallback()`	Returns the callback called to set the right edge of the annotation.
`Date`	`getXMinAsDate()`	Returns the left edge of the annotation, in units along the x axis.
`double`	`getXMinAsDouble()`	Returns the left edge of the annotation, in units along the x axis.
`String`	`getXMinAsString()`	Returns the left edge of the annotation, in units along the x axis.
`ValueCallback`	`getXMinCallback()`	Returns the callback called to set the left edge of the annotation, in units along the x axis.
`ScaleId`	`getXScaleID()`	Returns the ID of the X scale to bind onto.
`Date`	`getYMaxAsDate()`	Returns the top edge of the annotation in units along the y axis.
`double`	`getYMaxAsDouble()`	Returns the top edge of the annotation in units along the y axis.
`String`	`getYMaxAsString()`	Returns the top edge of the annotation in units along the y axis.
`ValueCallback`	`getYMaxCallback()`	Returns the callback called to set the top edge of the annotation in units along the y axis.
`Date`	`getYMinAsDate()`	Returns the bottom edge of the annotation.
`double`	`getYMinAsDouble()`	Returns the bottom edge of the annotation.
`String`	`getYMinAsString()`	Returns the bottom edge of the annotation.
`ValueCallback`	`getYMinCallback()`	Returns the callback called to set the bottom edge of the annotation.
`ScaleId`	`getYScaleID()`	Returns the ID of the Y scale to bind onto.
`int`	`getZ()`	Returns the property determines the drawing stack level of the box annotation element. All visible elements will be drawn in ascending order of `z` option, with the same "drawTime" option.
`ZCallback`	`getZCallback()`	Returns the callback called to set the property determines the drawing stack level of the box annotation element.
`boolean`	`isAdjustScaleRange()`	Returns `true` whether the scale range should be adjusted if this annotation is out of range.
`boolean`	`isDisplay()`	Returns `true` whether the annotation should be displayed.
`boolean`	`isInit()`	Returns `true` to enable the animation to the annotations when they are drawing at chart initialization.
`void`	`setAdjustScaleRange(boolean display)`	Sets `true` whether the scale range should be adjusted if this annotation is out of range.
`void`	`setAdjustScaleRange(AdjustScaleRangeCallback adjustScaleRangeCallback)`	Sets the callback to set whether the scale range should be adjusted if this annotation is out of range.
`void`	`setAdjustScaleRange(NativeCallback adjustScaleRangeCallback)`	Sets the callback to set whether the scale range should be adjusted if this annotation is out of range.
`void`	`setAfterDraw(ElementHookCallback afterDrawCallback)`	Sets the callback to get the control after the annotation element drawing.
`void`	`setAfterDraw(NativeCallback afterDrawCallback)`	Sets the callback to get the control after the annotation element drawing.
`void`	`setBeforeDraw(ElementHookCallback beforeDrawCallback)`	Sets the callback to get the control before the annotation element drawing.
`void`	`setBeforeDraw(NativeCallback beforeDrawCallback)`	Sets the callback to get the control before the annotation element drawing.
`default void`	`setBorderColor(String borderColor)`	Sets the color of the border of annotation.
`default void`	`setBorderColor(ColorCallback<AnnotationContext> borderColorCallback)`	Sets the callback to set the color of the border of annotation.
`default void`	`setBorderColor(NativeCallback borderColorCallback)`	Sets the callback to set the color of the border of annotation.
`default void`	`setBorderColor(IsColor borderColor)`	Sets the color of the border of annotation.
`default 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.
`default void`	`setBorderDash(BorderDashCallback<AnnotationContext> borderDashCallback)`	Sets the callback 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 void`	`setBorderDash(NativeCallback borderDashCallback)`	Sets the callback 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 void`	`setBorderDashOffset(double borderDashOffset)`	Sets the line dash pattern offset.
`default void`	`setBorderDashOffset(BorderDashOffsetCallback<AnnotationContext> borderDashOffsetCallback)`	Sets the callback to set the line dash pattern offset.
`default void`	`setBorderDashOffset(NativeCallback borderDashOffsetCallback)`	Sets the callback to set the line dash pattern offset.
`default void`	`setBorderShadowColor(String borderColor)`	Sets the color of the border shadow of annotation.
`default void`	`setBorderShadowColor(ColorCallback<AnnotationContext> borderShadowColorCallback)`	Sets the callback to set the color of the border shadow of annotation.
`default void`	`setBorderShadowColor(NativeCallback borderShadowColorCallback)`	Sets the callback to set the color of the border shadow of annotation.
`default void`	`setBorderShadowColor(IsColor borderColor)`	Sets the color of the border shadow of annotation.
`default void`	`setBorderWidth(int borderWidth)`	Sets the width of the border in pixels.
`default void`	`setBorderWidth(NativeCallback borderWidthCallback)`	Sets the callback to set the color of the width of the border in pixels.
`default void`	`setBorderWidth(WidthCallback<AnnotationContext> borderWidthCallback)`	Sets the callback to set the color of the width of the border in pixels.
`default void`	`setClickCallback(ClickCallback clickCallback)`	Sets the callback called when a "click" event is occurring.
`void`	`setDisplay(boolean display)`	Sets `true` whether the annotation should be displayed.
`void`	`setDisplay(NativeCallback displayCallback)`	Sets the callback to set whether the annotation should be displayed.
`void`	`setDisplay(SimpleDisplayCallback<AnnotationContext> displayCallback)`	Sets the callback to set whether the annotation should be displayed.
`void`	`setDrawTime(DrawTimeCallback drawTimeCallback)`	Sets the callback to set the draw time which defines when the annotations are drawn.
`void`	`setDrawTime(DrawTime drawTime)`	Sets the draw time which defines when the annotations are drawn.
`void`	`setDrawTime(NativeCallback drawTimeCallback)`	Sets the callback to set the draw time which defines when the annotations are drawn.
`default void`	`setEnterCallback(EnterCallback enterCallback)`	Sets the callback called when a "enter" event is occurring.
`void`	`setInit(boolean init)`	Sets `true` to enable the animation to the annotations when they are drawing at chart initialization.
`void`	`setInit(InitCallback initCallback)`	Sets the callback to get the control after the annotation element drawing.
`void`	`setInit(NativeCallback initCallback)`	Sets the callback to get the control after the annotation element drawing.
`default void`	`setLeaveCallback(LeaveCallback leaveCallback)`	Sets the callback called when a "leave" event is occurring.
`default void`	`setShadowBlur(double shadowBlur)`	Sets the amount of blur applied to shadows.
`default void`	`setShadowBlur(ShadowBlurCallback shadowBlurCallback)`	Sets the callback to set the amount of blur applied to shadows.
`default void`	`setShadowBlur(NativeCallback shadowBlurCallback)`	Sets the callback to set the amount of blur applied to shadows.
`default void`	`setShadowOffsetX(int shadowOffset)`	Sets the distance that shadows will be offset horizontally.
`default void`	`setShadowOffsetX(ShadowOffsetCallback shadowOffsetCallback)`	Sets the callback to set the distance that shadows will be offset horizontally.
`default void`	`setShadowOffsetX(NativeCallback shadowOffsetCallback)`	Sets the callback to set the distance that shadows will be offset horizontally.
`default void`	`setShadowOffsetY(int shadowOffset)`	Sets the distance that shadows will be offset vertically.
`default void`	`setShadowOffsetY(ShadowOffsetCallback shadowOffsetCallback)`	Sets the callback to set the distance that shadows will be offset vertically.
`default void`	`setShadowOffsetY(NativeCallback shadowOffsetCallback)`	Sets the callback to set the distance that shadows will be offset vertically.
`void`	`setXMax(double max)`	Sets the right edge of the annotation.
`void`	`setXMax(String max)`	Sets the right edge of the annotation.
`void`	`setXMax(Date max)`	Sets the right edge of the annotation.
`void`	`setXMax(ValueCallback valueCallback)`	Sets the callback to set the right edge of the annotation.
`void`	`setXMax(NativeCallback valueCallback)`	Sets the callback to set the right edge of the annotation.
`void`	`setXMin(double min)`	Sets the left edge of the annotation, in units along the x axis.
`void`	`setXMin(String min)`	Sets the left edge of the annotation, in units along the x axis.
`void`	`setXMin(Date min)`	Sets the left edge of the annotation, in units along the x axis.
`void`	`setXMin(ValueCallback valueCallback)`	Sets the callback to set the left edge of the annotation, in units along the x axis.
`void`	`setXMin(NativeCallback valueCallback)`	Sets the callback to set the left edge of the annotation, 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 annotation in units along the y axis.
`void`	`setYMax(String max)`	Sets the top edge of the annotation in units along the y axis.
`void`	`setYMax(Date max)`	Sets the top edge of the annotation in units along the y axis.
`void`	`setYMax(ValueCallback valueCallback)`	Sets the callback to set the top edge of the annotation in units along the y axis.
`void`	`setYMax(NativeCallback valueCallback)`	Sets the callback to set the top edge of the annotation in units along the y axis.
`void`	`setYMin(double min)`	Sets the bottom edge of the annotation.
`void`	`setYMin(String min)`	Sets the bottom edge of the annotation.
`void`	`setYMin(Date min)`	Sets the bottom edge of the annotation.
`void`	`setYMin(ValueCallback valueCallback)`	Sets the callback to set the bottom edge of the annotation.
`void`	`setYMin(NativeCallback valueCallback)`	Sets the callback to set the bottom edge of the annotation.
`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.
`void`	`setZ(int z)`	Sets the property determines the drawing stack level of the box annotation element. All visible elements will be drawn in ascending order of `z` option, with the same "drawTime" option.
`void`	`setZ(ZCallback zCallback)`	Sets the callback called to set the property determines the drawing stack level of the box annotation element.
`void`	`setZ(NativeCallback zCallback)`	Sets the callback called to set the property determines the drawing stack level of the box annotation element.

Methods inherited from class org.pepstock.charba.client.commons.AbstractNode
checkAndAddToParent, getChildKey, getParentNode, getRootNode, getUpdateListener, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setUpdateListener, setValueAndAddToParent, setValueAndAddToParent, 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
checkAndGetColor, 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, 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, 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_DISPLAY
```
public static final boolean DEFAULT_DISPLAY
```
    Default annotation display, true.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INIT
```
public static final boolean DEFAULT_INIT
```
    Default annotation animation initialization, false.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ADJUST_SCALE_RANGE
```
public static final boolean DEFAULT_ADJUST_SCALE_RANGE
```
    Default annotation adjust scale range, true.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ROTATION
```
public static final double DEFAULT_ROTATION
```
    Default annotation rotation, 0.0.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_Z
```
public static final int DEFAULT_Z
```
    Default annotation Z, 0.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getBorderOptionsHandler
```
public final org.pepstock.charba.client.annotation.BorderOptionsHandler getBorderOptionsHandler()
```
  - getShadowOptionsHandler
```
public final org.pepstock.charba.client.annotation.ShadowOptionsHandler getShadowOptionsHandler()
```
  - getEventsHandler
```
public final org.pepstock.charba.client.annotation.EventsHandler getEventsHandler()
```
  - getId
```
public final AnnotationId getId()
```
    Returns the id of annotation.
    
    Returns:
    
    the id of annotation
  - getType
```
public final AnnotationType getType()
```
    Returns the type of annotation.
    
    Returns:
    
    the type of annotation
  - setDisplay
```
public final void setDisplay(boolean display)
```
    Sets true whether the annotation should be displayed.
    
    Parameters:
    
    display - true whether the annotation should be displayed
  - isDisplay
```
public final boolean isDisplay()
```
    Returns true whether the annotation should be displayed.
    
    Returns:
    
    true whether the annotation should be displayed
  - setInit
```
public final void setInit(boolean init)
```
    Sets true to enable the animation to the annotations when they are drawing at chart initialization.
    
    Parameters:
    
    init - true to enable the animation to the annotations when they are drawing at chart initialization
  - isInit
```
public final boolean isInit()
```
    Returns true to enable the animation to the annotations when they are drawing at chart initialization.
    
    Returns:
    
    true to enable the animation to the annotations when they are drawing at chart initialization.
  - setAdjustScaleRange
```
public final void setAdjustScaleRange(boolean display)
```
    Sets true whether the scale range should be adjusted if this annotation is out of range.
    
    Parameters:
    
    display - true whether the scale range should be adjusted if this annotation is out of range
  - isAdjustScaleRange
```
public final 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
  - setZ
```
public final void setZ(int z)
```
    Sets the property determines the drawing stack level of the box annotation element.
    All visible elements will be drawn in ascending order of `z` option, with the same "drawTime" option.
    
    Parameters:
    
    z - the property determines the drawing stack level of the box annotation element.
    All visible elements will be drawn in ascending order of `z` option, with the same "drawTime" option.
  - getZ
```
public final int getZ()
```
    Returns the property determines the drawing stack level of the box annotation element.
    All visible elements will be drawn in ascending order of `z` option, with the same "drawTime" option.
    
    Returns:
    
    the property determines the drawing stack level of the box annotation element.
    All visible elements will be drawn in ascending order of `z` option, with the same "drawTime" option.
  - setDrawTime
```
public final void setDrawTime(DrawTime drawTime)
```
    Sets the draw time which defines when the annotations are drawn.
    
    Parameters:
    
    drawTime - the draw time which defines when the annotations are drawn
  - getDrawTime
```
public final DrawTime getDrawTime()
```
    Returns the draw time which defines when the annotations are drawn.
    
    Returns:
    
    the draw time which defines when the annotations are drawn
  - 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 annotation.
    
    Parameters:
    
    max - the right edge of the annotation
  - setXMax
```
public final void setXMax(double max)
```
    Sets the right edge of the annotation.
    
    Parameters:
    
    max - the right edge of the annotation
  - setXMax
```
public final void setXMax(Date max)
```
    Sets the right edge of the annotation.
    
    Parameters:
    
    max - the right edge of the annotation
  - getXMaxAsString
```
public final String getXMaxAsString()
```
    Returns the right edge of the annotation.
    
    Returns:
    
    the right edge of the annotation
  - getXMaxAsDouble
```
public final double getXMaxAsDouble()
```
    Returns the right edge of the annotation.
    
    Returns:
    
    the right edge of the annotation
  - getXMaxAsDate
```
public final Date getXMaxAsDate()
```
    Returns the right edge of the annotation.
    
    Returns:
    
    the right edge of the annotation
  - setXMin
```
public final void setXMin(String min)
```
    Sets the left edge of the annotation, in units along the x axis.
    
    Parameters:
    
    min - the left edge of the annotation
  - setXMin
```
public final void setXMin(double min)
```
    Sets the left edge of the annotation, in units along the x axis.
    
    Parameters:
    
    min - the left edge of the annotation
  - setXMin
```
public final void setXMin(Date min)
```
    Sets the left edge of the annotation, in units along the x axis.
    
    Parameters:
    
    min - the left edge of the annotation
  - getXMinAsString
```
public final String getXMinAsString()
```
    Returns the left edge of the annotation, in units along the x axis.
    
    Returns:
    
    the left edge of the annotation
  - getXMinAsDouble
```
public final double getXMinAsDouble()
```
    Returns the left edge of the annotation, in units along the x axis.
    
    Returns:
    
    the left edge of the annotation
  - getXMinAsDate
```
public final Date getXMinAsDate()
```
    Returns the left edge of the annotation, in units along the x axis.
    
    Returns:
    
    the left edge of the annotation
  - 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 annotation in units along the y axis.
    
    Parameters:
    
    max - the top edge of the annotation in units along the y axis
  - setYMax
```
public final void setYMax(double max)
```
    Sets the top edge of the annotation in units along the y axis.
    
    Parameters:
    
    max - the top edge of the annotation in units along the y axis
  - setYMax
```
public final void setYMax(Date max)
```
    Sets the top edge of the annotation in units along the y axis.
    
    Parameters:
    
    max - the top edge of the annotation in units along the y axis
  - getYMaxAsString
```
public final String getYMaxAsString()
```
    Returns the top edge of the annotation in units along the y axis.
    
    Returns:
    
    the top edge of the annotation in units along the y axis
  - getYMaxAsDouble
```
public final double getYMaxAsDouble()
```
    Returns the top edge of the annotation in units along the y axis.
    
    Returns:
    
    the top edge of the annotation in units along the y axis
  - getYMaxAsDate
```
public final Date getYMaxAsDate()
```
    Returns the top edge of the annotation in units along the y axis.
    
    Returns:
    
    the top edge of the annotation in units along the y axis
  - setYMin
```
public final void setYMin(String min)
```
    Sets the bottom edge of the annotation.
    
    Parameters:
    
    min - the bottom edge of the annotation
  - setYMin
```
public final void setYMin(double min)
```
    Sets the bottom edge of the annotation.
    
    Parameters:
    
    min - the bottom edge of the annotation
  - setYMin
```
public final void setYMin(Date min)
```
    Sets the bottom edge of the annotation.
    
    Parameters:
    
    min - the bottom edge of the annotation
  - getYMinAsString
```
public final String getYMinAsString()
```
    Returns the bottom edge of the annotation.
    
    Returns:
    
    the bottom edge of the annotation
  - getYMinAsDouble
```
public final double getYMinAsDouble()
```
    Returns the bottom edge of the annotation.
    
    Returns:
    
    the bottom edge of the annotation
  - getYMinAsDate
```
public final Date getYMinAsDate()
```
    Returns the bottom edge of the annotation.
    
    Returns:
    
    the bottom edge of the annotation
  - getDrawTimeCallback
```
public final 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
  - setDrawTime
```
public final void setDrawTime(DrawTimeCallback drawTimeCallback)
```
    Sets the callback to set the draw time which defines when the annotations are drawn.
    
    Parameters:
    
    drawTimeCallback - to set the draw time which defines when the annotations are drawn
  - setDrawTime
```
public final void setDrawTime(NativeCallback drawTimeCallback)
```
    Sets the callback to set the draw time which defines when the annotations are drawn.
    
    Parameters:
    
    drawTimeCallback - to set the draw time which defines when the annotations are drawn
  - getDisplayCallback
```
public final SimpleDisplayCallback<AnnotationContext> getDisplayCallback()
```
    Returns the callback called to set whether the annotation should be displayed.
    
    Returns:
    
    the callback called to set whether the annotation should be displayed
  - setDisplay
```
public final void setDisplay(SimpleDisplayCallback<AnnotationContext> displayCallback)
```
    Sets the callback to set whether the annotation should be displayed.
    
    Parameters:
    
    displayCallback - to set whether the annotation should be displayed
  - setDisplay
```
public final void setDisplay(NativeCallback displayCallback)
```
    Sets the callback to set whether the annotation should be displayed.
    
    Parameters:
    
    displayCallback - to set whether the annotation should be displayed
  - getAdjustScaleRangeCallback
```
public final 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
  - setAdjustScaleRange
```
public final void setAdjustScaleRange(AdjustScaleRangeCallback adjustScaleRangeCallback)
```
    Sets the callback to set whether the scale range should be adjusted if this annotation is out of range.
    
    Parameters:
    
    adjustScaleRangeCallback - to set whether the scale range should be adjusted if this annotation is out of range
  - setAdjustScaleRange
```
public final void setAdjustScaleRange(NativeCallback adjustScaleRangeCallback)
```
    Sets the callback to set whether the scale range should be adjusted if this annotation is out of range.
    
    Parameters:
    
    adjustScaleRangeCallback - to set whether the scale range should be adjusted if this annotation is out of range
  - getZCallback
```
public final ZCallback getZCallback()
```
    Returns the callback called to set the property determines the drawing stack level of the box annotation element.
    
    Returns:
    
    the callback called to set the property determines the drawing stack level of the box annotation element
  - setZ
```
public final void setZ(ZCallback zCallback)
```
    Sets the callback called to set the property determines the drawing stack level of the box annotation element.
    
    Parameters:
    
    zCallback - to set the property determines the drawing stack level of the box annotation element
  - setZ
```
public final void setZ(NativeCallback zCallback)
```
    Sets the callback called to set the property determines the drawing stack level of the box annotation element.
    
    Parameters:
    
    zCallback - to set the property determines the drawing stack level of the box annotation element
  - getXMinCallback
```
public final ValueCallback getXMinCallback()
```
    Returns the callback called to set the left edge of the annotation, in units along the x axis.
    
    Returns:
    
    the callback called to set the left edge of the annotation, in units along the x axis
  - setXMin
```
public final void setXMin(ValueCallback valueCallback)
```
    Sets the callback to set the left edge of the annotation, in units along the x axis.
    
    Parameters:
    
    valueCallback - to set the left edge of the annotation, in units along the x axis
  - setXMin
```
public final void setXMin(NativeCallback valueCallback)
```
    Sets the callback to set the left edge of the annotation, in units along the x axis.
    
    Parameters:
    
    valueCallback - to set the left edge of the annotation, in units along the x axis
  - getXMaxCallback
```
public final ValueCallback getXMaxCallback()
```
    Returns the callback called to set the right edge of the annotation.
    
    Returns:
    
    the callback called to set the right edge of the annotation
  - setXMax
```
public final void setXMax(ValueCallback valueCallback)
```
    Sets the callback to set the right edge of the annotation.
    
    Parameters:
    
    valueCallback - to set the right edge of the annotation
  - setXMax
```
public final void setXMax(NativeCallback valueCallback)
```
    Sets the callback to set the right edge of the annotation.
    
    Parameters:
    
    valueCallback - to set the right edge of the annotation
  - getYMinCallback
```
public final ValueCallback getYMinCallback()
```
    Returns the callback called to set the bottom edge of the annotation.
    
    Returns:
    
    the callback called to set the bottom edge of the annotation
  - setYMin
```
public final void setYMin(ValueCallback valueCallback)
```
    Sets the callback to set the bottom edge of the annotation.
    
    Parameters:
    
    valueCallback - to set the bottom edge of the annotation
  - setYMin
```
public final void setYMin(NativeCallback valueCallback)
```
    Sets the callback to set the bottom edge of the annotation.
    
    Parameters:
    
    valueCallback - to set the bottom edge of the annotation
  - getYMaxCallback
```
public final ValueCallback getYMaxCallback()
```
    Returns the callback called to set the top edge of the annotation in units along the y axis.
    
    Returns:
    
    the callback called to set the top edge of the annotation in units along the y axis
  - setYMax
```
public final void setYMax(ValueCallback valueCallback)
```
    Sets the callback to set the top edge of the annotation in units along the y axis.
    
    Parameters:
    
    valueCallback - to set the top edge of the annotation in units along the y axis
  - setYMax
```
public final void setYMax(NativeCallback valueCallback)
```
    Sets the callback to set the top edge of the annotation in units along the y axis.
    
    Parameters:
    
    valueCallback - to set the top edge of the annotation in units along the y axis
  - getBeforeDrawCallback
```
public final ElementHookCallback getBeforeDrawCallback()
```
    Returns the callback called to get the control before the annotation element drawing.
    
    Returns:
    
    the callback called to get the control before the annotation element drawing
  - setBeforeDraw
```
public final void setBeforeDraw(ElementHookCallback beforeDrawCallback)
```
    Sets the callback to get the control before the annotation element drawing.
    
    Parameters:
    
    beforeDrawCallback - to get the control before the annotation element drawing
  - setBeforeDraw
```
public final void setBeforeDraw(NativeCallback beforeDrawCallback)
```
    Sets the callback to get the control before the annotation element drawing.
    
    Parameters:
    
    beforeDrawCallback - to get the control before the annotation element drawing
  - getAfterDrawCallback
```
public final ElementHookCallback getAfterDrawCallback()
```
    Returns the callback called to get the control after the annotation element drawing.
    
    Returns:
    
    the callback called to get the control after the annotation element drawing
  - setAfterDraw
```
public final void setAfterDraw(ElementHookCallback afterDrawCallback)
```
    Sets the callback to get the control after the annotation element drawing.
    
    Parameters:
    
    afterDrawCallback - to get the control after the annotation element drawing
  - setAfterDraw
```
public final void setAfterDraw(NativeCallback afterDrawCallback)
```
    Sets the callback to get the control after the annotation element drawing.
    
    Parameters:
    
    afterDrawCallback - to get the control after the annotation element drawing
  - getInitCallback
```
public final InitCallback getInitCallback()
```
    Returns the callback called to get the control after the annotation element drawing.
    
    Returns:
    
    the callback called to get the control after the annotation element drawing
  - setInit
```
public final void setInit(InitCallback initCallback)
```
    Sets the callback to get the control after the annotation element drawing.
    
    Parameters:
    
    initCallback - to get the control after the annotation element drawing
  - setInit
```
public final void setInit(NativeCallback initCallback)
```
    Sets the callback to get the control after the annotation element drawing.
    
    Parameters:
    
    initCallback - to get the control after the annotation element drawing
  - setBorderColor
```
public default void setBorderColor(IsColor borderColor)
```
    Sets the color of the border of annotation.
    
    Parameters:
    
    borderColor - the color of the border of annotation
  - setBorderColor
```
public default void setBorderColor(String borderColor)
```
    Sets the color of the border of annotation.
    
    Parameters:
    
    borderColor - the color of the border of annotation
  - getBorderColorAsString
```
public default String getBorderColorAsString()
```
    Returns the color of the border of annotation.
    
    Returns:
    
    the color of the border of annotation
  - getBorderColor
```
public default IsColor getBorderColor()
```
    Returns the color of the border of annotation.
    
    Returns:
    
    the color of the border of annotation
  - setBorderWidth
```
public default void setBorderWidth(int borderWidth)
```
    Sets the width of the border in pixels.
    
    Parameters:
    
    borderWidth - the width of the border in pixels.
  - getBorderWidth
```
public default int getBorderWidth()
```
    Returns the width of the border in pixels.
    
    Returns:
    
    the width of the border in pixels.
  - setBorderDash
```
public default 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 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.
  - setBorderDashOffset
```
public default void setBorderDashOffset(double borderDashOffset)
```
    Sets the line dash pattern offset.
    
    Parameters:
    
    borderDashOffset - the line dash pattern offset.
  - getBorderDashOffset
```
public default double getBorderDashOffset()
```
    Returns the line dash pattern offset.
    
    Returns:
    
    the line dash pattern offset.
  - 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
  - setBorderColor
```
public default void setBorderColor(ColorCallback<AnnotationContext> borderColorCallback)
```
    Sets the callback to set the color of the border of annotation.
    
    Parameters:
    
    borderColorCallback - to set the color of the border of annotation
  - setBorderColor
```
public default void setBorderColor(NativeCallback borderColorCallback)
```
    Sets the callback to set the color of the border of annotation.
    
    Parameters:
    
    borderColorCallback - 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
  - setBorderWidth
```
public default void setBorderWidth(WidthCallback<AnnotationContext> borderWidthCallback)
```
    Sets the callback to set the color of the width of the border in pixels.
    
    Parameters:
    
    borderWidthCallback - to set the width of the border in pixels
  - setBorderWidth
```
public default void setBorderWidth(NativeCallback borderWidthCallback)
```
    Sets the callback to set the color of the width of the border in pixels.
    
    Parameters:
    
    borderWidthCallback - 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
  - setBorderDash
```
public default void setBorderDash(BorderDashCallback<AnnotationContext> borderDashCallback)
```
    Sets the callback 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.
    
    Parameters:
    
    borderDashCallback - 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
  - setBorderDash
```
public default void setBorderDash(NativeCallback borderDashCallback)
```
    Sets the callback 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.
    
    Parameters:
    
    borderDashCallback - 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
  - setBorderDashOffset
```
public default void setBorderDashOffset(BorderDashOffsetCallback<AnnotationContext> borderDashOffsetCallback)
```
    Sets the callback to set the line dash pattern offset.
    
    Parameters:
    
    borderDashOffsetCallback - to set the line dash pattern offset
  - setBorderDashOffset
```
public default void setBorderDashOffset(NativeCallback borderDashOffsetCallback)
```
    Sets the callback to set the line dash pattern offset.
    
    Parameters:
    
    borderDashOffsetCallback - to set the line dash pattern offset
  - setBorderShadowColor
```
public default void setBorderShadowColor(IsColor borderColor)
```
    Sets the color of the border shadow of annotation.
    
    Parameters:
    
    borderColor - the color of the border shadow of annotation
  - setBorderShadowColor
```
public default void setBorderShadowColor(String borderColor)
```
    Sets the color of the border shadow of annotation.
    
    Parameters:
    
    borderColor - the color of the border shadow of annotation
  - getBorderShadowColorAsString
```
public default String getBorderShadowColorAsString()
```
    Returns the color of the border shadow of annotation.
    
    Returns:
    
    the color of the border shadow of annotation
  - getBorderShadowColor
```
public default IsColor getBorderShadowColor()
```
    Returns the color of the border shadow of annotation.
    
    Returns:
    
    the color of the border shadow of annotation
  - setShadowBlur
```
public default void setShadowBlur(double shadowBlur)
```
    Sets the amount of blur applied to shadows.
    
    Parameters:
    
    shadowBlur - the amount of blur applied to shadows
  - getShadowBlur
```
public default double getShadowBlur()
```
    Returns the amount of blur applied to shadows.
    
    Returns:
    
    the amount of blur applied to shadows
  - setShadowOffsetX
```
public default void setShadowOffsetX(int shadowOffset)
```
    Sets the distance that shadows will be offset horizontally.
    
    Parameters:
    
    shadowOffset - the distance that shadows will be offset horizontally.
  - getShadowOffsetX
```
public default int getShadowOffsetX()
```
    Returns the distance that shadows will be offset horizontally.
    
    Returns:
    
    the distance that shadows will be offset horizontally.
  - setShadowOffsetY
```
public default void setShadowOffsetY(int shadowOffset)
```
    Sets the distance that shadows will be offset vertically.
    
    Parameters:
    
    shadowOffset - the distance that shadows will be offset vertically.
  - getShadowOffsetY
```
public default int getShadowOffsetY()
```
    Returns the distance that shadows will be offset vertically.
    
    Returns:
    
    the distance that shadows will be offset vertically.
  - getBorderShadowColorCallback
```
public default ColorCallback<AnnotationContext> getBorderShadowColorCallback()
```
    Returns the callback called to set the color of the border shadow of annotation.
    
    Returns:
    
    the callback called to set the color of the border shadow of annotation
  - setBorderShadowColor
```
public default void setBorderShadowColor(ColorCallback<AnnotationContext> borderShadowColorCallback)
```
    Sets the callback to set the color of the border shadow of annotation.
    
    Parameters:
    
    borderShadowColorCallback - to set the color of the border shadow of annotation
  - setBorderShadowColor
```
public default void setBorderShadowColor(NativeCallback borderShadowColorCallback)
```
    Sets the callback to set the color of the border shadow of annotation.
    
    Parameters:
    
    borderShadowColorCallback - to set the color of the border shadow of annotation
  - getShadowBlurCallback
```
public default ShadowBlurCallback getShadowBlurCallback()
```
    Returns the callback called to set the amount of blur applied to shadows.
    
    Returns:
    
    the callback called to set the amount of blur applied to shadows.
  - setShadowBlur
```
public default void setShadowBlur(ShadowBlurCallback shadowBlurCallback)
```
    Sets the callback to set the amount of blur applied to shadows.
    
    Parameters:
    
    shadowBlurCallback - to set the amount of blur applied to shadows.
  - setShadowBlur
```
public default void setShadowBlur(NativeCallback shadowBlurCallback)
```
    Sets the callback to set the amount of blur applied to shadows.
    
    Parameters:
    
    shadowBlurCallback - to set the amount of blur applied to shadows.
  - getShadowOffsetXCallback
```
public default ShadowOffsetCallback getShadowOffsetXCallback()
```
    Returns the callback called to set the distance that shadows will be offset horizontally.
    
    Returns:
    
    the callback called to set the distance that shadows will be offset horizontally.
  - setShadowOffsetX
```
public default void setShadowOffsetX(ShadowOffsetCallback shadowOffsetCallback)
```
    Sets the callback to set the distance that shadows will be offset horizontally.
    
    Parameters:
    
    shadowOffsetCallback - to set the distance that shadows will be offset horizontally.
  - setShadowOffsetX
```
public default void setShadowOffsetX(NativeCallback shadowOffsetCallback)
```
    Sets the callback to set the distance that shadows will be offset horizontally.
    
    Parameters:
    
    shadowOffsetCallback - to set the distance that shadows will be offset horizontally.
  - getShadowOffsetYCallback
```
public default ShadowOffsetCallback getShadowOffsetYCallback()
```
    Returns the callback called to set the distance that shadows will be offset vertically.
    
    Returns:
    
    the callback called to set the distance that shadows will be offset vertically.
  - setShadowOffsetY
```
public default void setShadowOffsetY(ShadowOffsetCallback shadowOffsetCallback)
```
    Sets the callback to set the distance that shadows will be offset vertically.
    
    Parameters:
    
    shadowOffsetCallback - to set the distance that shadows will be offset vertically.
  - setShadowOffsetY
```
public default void setShadowOffsetY(NativeCallback shadowOffsetCallback)
```
    Sets the callback to set the distance that shadows will be offset vertically.
    
    Parameters:
    
    shadowOffsetCallback - to set the distance that shadows will be offset vertically.
  - 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
  - setEnterCallback
```
public default void setEnterCallback(EnterCallback enterCallback)
```
    Sets the callback called when a "enter" event is occurring.
    
    Parameters:
    
    enterCallback - 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
  - setLeaveCallback
```
public default void setLeaveCallback(LeaveCallback leaveCallback)
```
    Sets the callback called when a "leave" event is occurring.
    
    Parameters:
    
    leaveCallback - 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
  - setClickCallback
```
public default void setClickCallback(ClickCallback clickCallback)
```
    Sets the callback called when a "click" event is occurring.
    
    Parameters:
    
    clickCallback - the callback called when a "click" event is occurring

Class AbstractAnnotation

Field Summary

Method Summary

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_DISPLAY

DEFAULT_INIT

DEFAULT_ADJUST_SCALE_RANGE

DEFAULT_ROTATION

DEFAULT_Z

Method Detail

getBorderOptionsHandler

getShadowOptionsHandler

getEventsHandler

getId

getType

setDisplay

isDisplay

setInit

isInit

setAdjustScaleRange

isAdjustScaleRange

setZ

getZ

setDrawTime

getDrawTime

setXScaleID

setXScaleID

getXScaleID

setXMax

setXMax

setXMax

getXMaxAsString

getXMaxAsDouble

getXMaxAsDate

setXMin

setXMin

setXMin

getXMinAsString

getXMinAsDouble

getXMinAsDate

setYScaleID

setYScaleID

getYScaleID

setYMax

setYMax

setYMax

getYMaxAsString

getYMaxAsDouble

getYMaxAsDate

setYMin

setYMin

setYMin

getYMinAsString

getYMinAsDouble

getYMinAsDate

getDrawTimeCallback

setDrawTime

setDrawTime

getDisplayCallback

setDisplay

setDisplay

getAdjustScaleRangeCallback

setAdjustScaleRange

setAdjustScaleRange

getZCallback

setZ

setZ

getXMinCallback

setXMin

setXMin

getXMaxCallback

setXMax

setXMax

getYMinCallback

setYMin

setYMin

getYMaxCallback