Package org.pepstock.charba.client.annotation

Class PolygonAnnotation

  • public final class PolygonAnnotation
extends AbstractAnnotation
    Implements a POLYGON annotation which draws a polygon in the a chart.
    Author:
    Andrea "Stock" Stocchero

    • Field Detail

      • DEFAULT_BORDER_WIDTH

        public static final int DEFAULT_BORDER_WIDTH
        Default polygon annotation border width, 1.
        See Also:
        Constant Field Values

      • DEFAULT_RADIUS

        public static final double DEFAULT_RADIUS
        Default polygon annotation radius, 10.0.
        See Also:
        Constant Field Values

      • DEFAULT_BORDER_CAP_STYLE

        public static final CapStyle DEFAULT_BORDER_CAP_STYLE
        Default box annotation border cap style, CapStyle.BUTT.

      • DEFAULT_BORDER_JOIN_STYLE

        public static final JoinStyle DEFAULT_BORDER_JOIN_STYLE
        Default box annotation border join style, JoinStyle.MITER.

      • DEFAULT_SIDES

        public static final int DEFAULT_SIDES
        Default polygon annotation sides, 3.
        See Also:
        Constant Field Values

      • MINIMUM_SIDES

        public static final int MINIMUM_SIDES
        Minimum value of polygon annotation sides, 3.
        See Also:
        Constant Field Values

      • DEFAULT_X_ADJUST

        public static final double DEFAULT_X_ADJUST
        Default annotation X adjust, 0.0.
        See Also:
        Constant Field Values

      • DEFAULT_Y_ADJUST

        public static final double DEFAULT_Y_ADJUST
        Default annotation Y adjust, 0.0.
        See Also:
        Constant Field Values

    • Constructor Detail

      • PolygonAnnotation

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

      • PolygonAnnotation

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

      • PolygonAnnotation

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

      • PolygonAnnotation

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

      • getExtendedBorderOptionsHandler

        public org.pepstock.charba.client.annotation.ExtendedBorderOptionsHandler getExtendedBorderOptionsHandler()

      • setSides

        public void setSides​(int sides)
        Sets the sides of the polygon shape.
        Parameters:
        sides - the sides of the polygon shape

      • getSides

        public int getSides()
        Returns the sides of the polygon shape.
        Returns:
        the sides of the polygon shape.

      • getSidesCallback

        public SidesCallback getSidesCallback()
        Returns the callback called to set the border sides.
        Returns:
        the callback called to set the border sides

      • setSides

        public void setSides​(SidesCallback sidesCallback)
        Sets the callback to set the border sides.
        Parameters:
        sidesCallback - to set the border sides

      • setSides

        public void setSides​(NativeCallback sidesCallback)
        Sets the callback to set the border sides.
        Parameters:
        sidesCallback - to set the border sides

      • getRadius

        public default double getRadius()
        Returns the radius of the point.
        Returns:
        the radius of the point.

      • getRadiusCallback

        public default RadiusCallback<AnnotationContext> getRadiusCallback()
        Returns the callback called to set the radius.
        Returns:
        the callback called to set the radius

      • getXValueAsString

        public default String getXValueAsString()
        Returns the data X value to draw the annotation at.
        Returns:
        the data X value to draw the annotation at

      • getXValueAsDouble

        public default double getXValueAsDouble()
        Returns the data X value to draw the annotation at.
        Returns:
        the data X value to draw the annotation at

      • getXValueAsDate

        public default Date getXValueAsDate()
        Returns the data X value to draw the annotation at.
        Returns:
        the data X value to draw the annotation at

      • getYValueAsString

        public default String getYValueAsString()
        Returns the data Y value to draw the annotation at.
        Returns:
        the data Y value to draw the annotation at

      • getYValueAsDouble

        public default double getYValueAsDouble()
        Returns the data Y value to draw the annotation at.
        Returns:
        the data Y value to draw the annotation at

      • getYValueAsDate

        public default Date getYValueAsDate()
        Returns the data Y value to draw the annotation at.
        Returns:
        the data Y value to draw the annotation at

      • getXValueCallback

        public default ValueCallback getXValueCallback()
        Returns the callback called to set the data X value to draw the annotation at.
        Returns:
        the callback called to set the data X value to draw the annotation at

      • getYValueCallback

        public default ValueCallback getYValueCallback()
        Returns the callback called to set the data Y value to draw the annotation at.
        Returns:
        the callback called to set the data Y value to draw the annotation at

      • getXAdjust

        public default double getXAdjust()
        Returns the adjustment along x-axis (left-right) of annotation relative to above number (can be negative).
        Returns:
        the adjustment along x-axis (left-right) of annotation

      • getYAdjust

        public default double getYAdjust()
        Returns the adjustment along y-axis (top-bottom) of annotation relative to above number (can be negative).
        Returns:
        the adjustment along y-axis (top-bottom) of annotation

      • getXAdjustCallback

        public default AdjustSizeCallback getXAdjustCallback()
        Returns the callback called to set the adjustment along x-axis (left-right) of annotation relative to above number (can be negative).
        Returns:
        the callback called to set the adjustment along x-axis (left-right) of annotation relative to above number (can be negative)

      • getYAdjustCallback

        public default AdjustSizeCallback getYAdjustCallback()
        Returns the callback called to set the adjustment along y-axis (top-bottom) of annotation relative to above number (can be negative).
        Returns:
        the callback called to set the adjustment along y-axis (top-bottom) of annotation relative to above number (can be negative)

      • 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

      • 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

      • setBorderCapStyle

        public default void setBorderCapStyle​(CapStyle borderCapStyle)
        Sets how the end points of every line are drawn.
        Parameters:
        borderCapStyle - how the end points of every line are drawn.

      • getBorderCapStyle

        public default CapStyle getBorderCapStyle()
        Returns how the end points of every line are drawn.
        Returns:
        how the end points of every line are drawn.

      • setBorderJoinStyle

        public default void setBorderJoinStyle​(JoinStyle borderJoinStyle)
        Sets how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified end points and control points are exactly at the same position, are skipped).
        Parameters:
        borderJoinStyle - how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together

      • getBorderJoinStyle

        public default JoinStyle getBorderJoinStyle()
        Returns how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified end points and control points are exactly at the same position, are skipped).
        Returns:
        how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together

      • getBorderCapStyleCallback

        public default CapStyleCallback<AnnotationContext> getBorderCapStyleCallback()
        Returns the border capstyle callback, if set, otherwise null.
        Returns:
        the border capstyle callback, if set, otherwise null.

      • setBorderCapStyle

        public default void setBorderCapStyle​(CapStyleCallback<AnnotationContext> borderCapStyleCallback)
        Sets the border capstyle callback.
        Parameters:
        borderCapStyleCallback - the border capstyle callback.

      • setBorderCapStyle

        public default void setBorderCapStyle​(NativeCallback borderCapStyleCallback)
        Sets the border capstyle callback.
        Parameters:
        borderCapStyleCallback - the border capstyle callback.

      • getBorderJoinStyleCallback

        public default JoinStyleCallback<AnnotationContext> getBorderJoinStyleCallback()
        Returns the border join style callback, if set, otherwise null.
        Returns:
        the border join style callback, if set, otherwise null.

      • setBorderJoinStyle

        public default void setBorderJoinStyle​(JoinStyleCallback<AnnotationContext> borderJoinStyleCallback)
        Sets the border join style callback.
        Parameters:
        borderJoinStyleCallback - the border join style callback.

      • setBorderJoinStyle

        public default void setBorderJoinStyle​(NativeCallback borderJoinStyleCallback)
        Sets the border join style callback.
        Parameters:
        borderJoinStyleCallback - the border join style callback.

      • getRotationHandler

        public final org.pepstock.charba.client.annotation.RotationHandler getRotationHandler()

      • setRadius

        public final void setRadius​(double radius)
        Sets the radius of the annotation shape.
        If set to 0, the annotation is not rendered.
        Parameters:
        radius - array of the radius of the point shape.

      • getRadius

        public final double getRadius()
        Returns the radius of the annotation.
        Returns:
        the radius of the annotation.

      • getRadiusCallback

        public final RadiusCallback<AnnotationContext> getRadiusCallback()
        Returns the callback called to set the radius.
        Returns:
        the callback called to set the radius

      • setRadius

        public final void setRadius​(RadiusCallback<AnnotationContext> radiusCallback)
        Sets the callback to set the radius.
        Parameters:
        radiusCallback - to set the radius

      • setRadius

        public final void setRadius​(NativeCallback radiusCallback)
        Sets the callback to set the radius.
        Parameters:
        radiusCallback - to set the radius

      • setRotation

        public default void setRotation​(double radius)
        Sets the rotation.
        Parameters:
        radius - the rotation.

      • getRotation

        public default double getRotation()
        Returns the rotation (in pixels).
        Returns:
        the rotation (in pixels).

      • getRotationCallback

        public default RotationCallback<AnnotationContext> getRotationCallback()
        Returns the callback called to set the rotation.
        Returns:
        the callback called to set the rotation

      • setRotation

        public default void setRotation​(RotationCallback<AnnotationContext> rotationCallback)
        Sets the callback to set the rotation.
        Parameters:
        rotationCallback - to set the rotation

      • setRotation

        public default void setRotation​(NativeCallback rotationCallback)
        Sets the callback to set the rotation.
        Parameters:
        rotationCallback - to set the rotation

      • getBackgroundColorHandler

        public final org.pepstock.charba.client.annotation.BackgroundColorHandler getBackgroundColorHandler()

      • getExtendedShadowOptionsHandler

        public final org.pepstock.charba.client.annotation.ExtendedShadowOptionsHandler getExtendedShadowOptionsHandler()

      • setXValue

        public final void setXValue​(String value)
        Sets the data X value to draw the annotation at.
        Parameters:
        value - the data X value to draw the annotation at

      • setXValue

        public final void setXValue​(double value)
        Sets the data X value to draw the annotation at.
        Parameters:
        value - the data X value to draw the annotation at

      • setXValue

        public final void setXValue​(Date value)
        Sets the data X value to draw the annotation at.
        Parameters:
        value - the data X value to draw the annotation at

      • getXValueAsString

        public final String getXValueAsString()
        Returns the data X value to draw the annotation at.
        Returns:
        the data X value to draw the annotation at

      • getXValueAsDouble

        public final double getXValueAsDouble()
        Returns the data X value to draw the annotation at.
        Returns:
        the data X value to draw the annotation at

      • getXValueAsDate

        public final Date getXValueAsDate()
        Returns the data X value to draw the annotation at.
        Returns:
        the data X value to draw the annotation at

      • setYValue

        public final void setYValue​(String value)
        Sets the data Y value to draw the annotation at.
        Parameters:
        value - the data Y value to draw the annotation at

      • setYValue

        public final void setYValue​(double value)
        Sets the data Y value to draw the annotation at.
        Parameters:
        value - the data Y value to draw the annotation at

      • setYValue

        public final void setYValue​(Date value)
        Sets the data Y value to draw the annotation at.
        Parameters:
        value - the data Y value to draw the annotation at

      • getYValueAsString

        public final String getYValueAsString()
        Returns the data Y value to draw the annotation at.
        Returns:
        the data Y value to draw the annotation at

      • getYValueAsDouble

        public final double getYValueAsDouble()
        Returns the data Y value to draw the annotation at.
        Returns:
        the data Y value to draw the annotation at

      • getYValueAsDate

        public final Date getYValueAsDate()
        Returns the data Y value to draw the annotation at.
        Returns:
        the data Y value to draw the annotation at

      • setYAdjust

        public final void setYAdjust​(double yAdjust)
        Sets the adjustment along y-axis (top-bottom) of annotation relative to above number (can be negative).
        Parameters:
        yAdjust - the adjustment along y-axis (top-bottom) of annotation

      • getYAdjust

        public final double getYAdjust()
        Returns the adjustment along y-axis (top-bottom) of annotation relative to above number (can be negative).
        Returns:
        the adjustment along y-axis (top-bottom) of annotation

      • setXAdjust

        public final void setXAdjust​(double xAdjust)
        Sets the adjustment along x-axis (left-right) of annotation relative to above number (can be negative).
        Parameters:
        xAdjust - the adjustment along x-axis (left-right) of annotation

      • getXAdjust

        public final double getXAdjust()
        Returns the adjustment along x-axis (left-right) of annotation relative to above number (can be negative).
        Returns:
        the adjustment along x-axis (left-right) of annotation

      • getXValueCallback

        public final ValueCallback getXValueCallback()
        Returns the callback called to set the data X value to draw the annotation at.
        Returns:
        the callback called to set the data X value to draw the annotation at

      • setXValue

        public final void setXValue​(ValueCallback valueCallback)
        Sets the callback to set the data X value to draw the annotation at.
        Parameters:
        valueCallback - to set the data X value to draw the annotation at

      • setXValue

        public final void setXValue​(NativeCallback valueCallback)
        Sets the callback to set the data X value to draw the annotation at.
        Parameters:
        valueCallback - to set the data X value to draw the annotation at

      • getYValueCallback

        public final ValueCallback getYValueCallback()
        Returns the callback called to set the data Y value to draw the annotation at.
        Returns:
        the callback called to set the data Y value to draw the annotation at

      • setYValue

        public final void setYValue​(ValueCallback valueCallback)
        Sets the callback to set the data Y value to draw the annotation at.
        Parameters:
        valueCallback - to set the data Y value to draw the annotation at

      • setYValue

        public final void setYValue​(NativeCallback valueCallback)
        Sets the callback to set the data Y value to draw the annotation at.
        Parameters:
        valueCallback - to set the data Y value to draw the annotation at

      • getYAdjustCallback

        public final AdjustSizeCallback getYAdjustCallback()
        Returns the callback called to set the adjustment along y-axis (top-bottom) of annotation relative to above number (can be negative).
        Returns:
        the callback called to set the adjustment along y-axis (top-bottom) of annotation relative to above number (can be negative)

      • setYAdjust

        public final void setYAdjust​(AdjustSizeCallback adjustCallback)
        Sets the callback to set the adjustment along x-axis (left-right) of annotation relative to above number (can be negative).
        Parameters:
        adjustCallback - to set the adjustment along x-axis (left-right) of annotation relative to above number (can be negative)

      • setYAdjust

        public final void setYAdjust​(NativeCallback adjustCallback)
        Sets the callback to set the adjustment along x-axis (left-right) of annotation relative to above number (can be negative).
        Parameters:
        adjustCallback - to set the adjustment along x-axis (left-right) of annotation relative to above number (can be negative)

      • getXAdjustCallback

        public final AdjustSizeCallback getXAdjustCallback()
        Returns the callback called to set the adjustment along x-axis (left-right) of annotation relative to above number (can be negative).
        Returns:
        the callback called to set the adjustment along x-axis (left-right) of annotation relative to above number (can be negative)

      • setXAdjust

        public final void setXAdjust​(AdjustSizeCallback adjustCallback)
        Sets the callback to set the adjustment along y-axis (top-bottom) of annotation relative to above number (can be negative).
        Parameters:
        adjustCallback - to set the adjustment along y-axis (top-bottom) of annotation relative to above number (can be negative)

      • setXAdjust

        public final void setXAdjust​(NativeCallback adjustCallback)
        Sets the callback to set the adjustment along y-axis (top-bottom) of annotation relative to above number (can be negative).
        Parameters:
        adjustCallback - to set the adjustment along y-axis (top-bottom) of annotation relative to above number (can be negative)

      • 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

      • setBackgroundShadowColor

        public default void setBackgroundShadowColor​(IsColor backgroundColor)
        Sets the color of the shadow of annotation.
        Parameters:
        backgroundColor - the color of the shadow of annotation

      • setBackgroundShadowColor

        public default void setBackgroundShadowColor​(String backgroundColor)
        Sets the color of the shadow of annotation.
        Parameters:
        backgroundColor - the color of the shadow of annotation

      • getBackgroundShadowColorAsString

        public default String getBackgroundShadowColorAsString()
        Returns the color of the shadow of annotation.
        Returns:
        the color of the shadow of annotation

      • getBackgroundShadowColor

        public default IsColor getBackgroundShadowColor()
        Returns the color of the shadow of annotation.
        Returns:
        the color of the shadow of annotation

      • getBackgroundShadowColorCallback

        public default ColorCallback<AnnotationContext> getBackgroundShadowColorCallback()
        Returns the callback called to set the color of the shadow of annotation.
        Returns:
        the callback called to set the color of the shadow of annotation

      • setBackgroundShadowColor

        public default void setBackgroundShadowColor​(ColorCallback<AnnotationContext> borderShadowColorCallback)
        Sets the callback to set the color of the shadow of annotation.
        Parameters:
        borderShadowColorCallback - to set the color of the shadow of annotation

      • setBackgroundShadowColor

        public default void setBackgroundShadowColor​(NativeCallback borderShadowColorCallback)
        Sets the callback to set the color of the shadow of annotation.
        Parameters:
        borderShadowColorCallback - to set the color of the shadow of annotation

      • 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