Package org.pepstock.charba.client.annotation

Class LineAnnotation

  • public final class LineAnnotation
extends AbstractAnnotation
    Implements a LINE annotation which draws a line in the a chart.
    Author:
    Andrea "Stock" Stocchero

    • Constructor Detail

      • LineAnnotation

        public LineAnnotation​(String id)
        Creates a line 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

      • LineAnnotation

        public LineAnnotation​(AnnotationId id)
        Creates a line annotation to be added to an AnnotationOptions instance, using the ID passed as argument.
        Parameters:
        id - annotation id to apply to the object

      • LineAnnotation

        public LineAnnotation​(String id,
                      IsChart chart)
        Creates a line 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

      • LineAnnotation

        public LineAnnotation​(AnnotationId id,
                      IsChart chart)
        Creates a line 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

      • getLabel

        public LineLabel getLabel()
        Returns the label on the line.
        Returns:
        the label on the line

      • getArrowHeads

        public ArrowHeads getArrowHeads()
        Returns the arrow heads of annotation.
        Returns:
        the arrow heads of annotation

      • setCurve

        public void setCurve​(boolean curve)
        Sets true if the line is set as a curve.
        Parameters:
        curve - true if the line is set as a curve.

      • isCurve

        public boolean isCurve()
        Returns true if the line is set as a curve.
        Returns:
        true if the line is set as a curve

      • setControlPoint

        public void setControlPoint​(double cp)
        Sets the control point to drawn the curve, calculated in pixels.
        Parameters:
        cp - the control point to drawn the curve.

      • setControlPointAsPercentage

        public void setControlPointAsPercentage​(double cp)
        Sets the control point to drawn the curve, calculated in percentage.
        Parameters:
        cp - the control point to drawn the curve.

      • setControlPoint

        public void setControlPoint​(String cp)
        Sets the control point to drawn the curve, calculated in percentage format 'number%' which are representing the percentage of the distance between the start and end point from the center.
        Parameters:
        cp - the control point to drawn the curve.

      • setControlPoint

        public void setControlPoint​(ControlPoint cp)
        Sets the control point to drawn the curve, calculated in pixels.
        It can be set by a string in percentage format 'number%' which are representing the percentage of the distance between the start and end point from the center.
        Parameters:
        cp - the control point to drawn the curve.

      • getControlPoint

        public ControlPoint getControlPoint()
        Returns the control point to drawn the curve, calculated in pixels.
        It can be set by a string in percentage format 'number%' which are representing the percentage of the distance between the start and end point from the center.
        Returns:
        the control point to drawn the curve

      • setScaleID

        public void setScaleID​(String scaleId)
        Sets the ID of the scale to bind onto.
        Parameters:
        scaleId - the ID of the scale to bind onto

      • setScaleID

        public void setScaleID​(ScaleId scaleId)
        Sets the ID of the scale to bind onto.
        Parameters:
        scaleId - the ID of the scale to bind onto

      • getScaleID

        public ScaleId getScaleID()
        Returns the ID of the scale to bind onto.
        Returns:
        the ID of the scale to bind onto

      • setValue

        public void setValue​(String value)
        Sets the data value to draw the line at.
        Parameters:
        value - the data value to draw the line at

      • setValue

        public void setValue​(double value)
        Sets the data value to draw the line at.
        Parameters:
        value - the data value to draw the line at

      • setValue

        public void setValue​(Date value)
        Sets the data value to draw the line at.
        Parameters:
        value - the data value to draw the line at

      • getValueAsString

        public String getValueAsString()
        Returns the data value to draw the line at.
        Returns:
        the data value to draw the line at

      • getValueAsDouble

        public double getValueAsDouble()
        Returns the data value to draw the line at.
        Returns:
        the data value to draw the line at

      • getValueAsDate

        public Date getValueAsDate()
        Returns the data value to draw the line at.
        Returns:
        the data value to draw the line at

      • setEndValue

        public void setEndValue​(String endValue)
        Sets the data value at which the line draw should end.
        Parameters:
        endValue - the data value at which the line draw should end

      • setEndValue

        public void setEndValue​(double endValue)
        Sets the data value at which the line draw should end.
        Parameters:
        endValue - the data value at which the line draw should end

      • setEndValue

        public void setEndValue​(Date endValue)
        Sets the data value at which the line draw should end.
        Parameters:
        endValue - the data value at which the line draw should end

      • getEndValueAsString

        public String getEndValueAsString()
        Returns the data value at which the line draw should end.
        Returns:
        the data value at which the line draw should end

      • getEndValueAsDouble

        public double getEndValueAsDouble()
        Returns the data value at which the line draw should end.
        Returns:
        the data value at which the line draw should end

      • getEndValueAsDate

        public Date getEndValueAsDate()
        Returns the data value at which the line draw should end.
        Returns:
        the data value at which the line draw should end

      • getValueCallback

        public ValueCallback getValueCallback()
        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

      • setValue

        public void setValue​(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

      • setValue

        public void setValue​(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

      • getEndValueCallback

        public ValueCallback getEndValueCallback()
        Returns the callback called to set the data value at which the line draw should end.
        Returns:
        the callback called to set the data value at which the line draw should end

      • setEndValue

        public void setEndValue​(ValueCallback valueCallback)
        Sets the callback to set the data value at which the line draw should end.
        Parameters:
        valueCallback - to set the data value at which the line draw should end

      • setEndValue

        public void setEndValue​(NativeCallback valueCallback)
        Sets the callback to set the data value at which the line draw should end.
        Parameters:
        valueCallback - to set the data value at which the line draw should end

      • getCurveCallback

        public CurveCallback getCurveCallback()
        Returns the callback called to set whether the annotation should be curve.
        Returns:
        the callback called to set whether the annotation should be curve

      • setCurve

        public void setCurve​(CurveCallback curveCallback)
        Sets the callback to set whether the annotation should be curve.
        Parameters:
        curveCallback - to set whether the annotation should be curve

      • setCurve

        public void setCurve​(NativeCallback curveCallback)
        Sets the callback to set whether the annotation should be curve.
        Parameters:
        curveCallback - to set whether the annotation should be curve

      • getControlPointCallback

        public ControlPointCallback getControlPointCallback()
        Returns the callback called to set the annotation control point for curve.
        Returns:
        the callback called to set the annotation control point for curve.

      • setControlPoint

        public void setControlPoint​(ControlPointCallback controlPointCallback)
        Sets the callback to set the annotation control point for curve.
        Parameters:
        controlPointCallback - to set the annotation control point for curve.

      • setControlPoint

        public void setControlPoint​(NativeCallback controlPointCallback)
        Sets the callback to set the annotation control point for curve.
        Parameters:
        controlPointCallback - to set the annotation control point for curve.

      • getType

        public abstract AnnotationType getType()
        Returns the type of annotation.
        Returns:
        the type of annotation

      • isDisplay

        public default boolean isDisplay()
        Returns true whether the annotation should be displayed.
        Returns:
        true whether the annotation should be displayed

      • isInit

        public default 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.

      • 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

      • getZ

        public default 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.

      • 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

      • 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 SimpleDisplayCallback<AnnotationContext> getDisplayCallback()
        Returns the callback called to set the display options.
        Returns:
        the callback called to set the display options

      • 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

      • getZCallback

        public default 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

      • 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

      • getBeforeDrawCallback

        public default 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

      • getAfterDrawCallback

        public default 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

      • getInitCallback

        public default InitCallback getInitCallback()
        Returns the callback called to get the control of animation initialization element.
        Returns:
        the callback called to get the control of animation initialization element

      • 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