org.pepstock.charba.client.datalabels

Class DataLabelsOptionsBuilder

java.lang.Object

org.pepstock.charba.client.datalabels.DataLabelsOptionsBuilder

public final class DataLabelsOptionsBuilder
extends Object

Comfortable object to create DataLabelsPlugin.ID plugin options by a builder.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
DataLabelsOptions	build() Returns a configured labels options.
static DataLabelsOptionsBuilder	create() Returns new builder instance.
static DataLabelsOptionsBuilder	create(IsChart chart) Returns new builder instance using the chart global options.
DataLabelsOptionsBuilder	setAlign(Align align) Sets the position of the label relative to the anchor point position and orientation.
DataLabelsOptionsBuilder	setAlign(AlignCallback alignCallback) Sets the align callback.
DataLabelsOptionsBuilder	setAnchor(Anchor anchor) Sets the anchor point, which is defined by an orientation vector and a position on the data element.
DataLabelsOptionsBuilder	setAnchor(AnchorCallback anchorCallback) Sets the anchor callback.
DataLabelsOptionsBuilder	setBackgroundColor(BackgroundColorCallback backgroundColorCallback) Sets the background color callback.
DataLabelsOptionsBuilder	setBackgroundColor(IsColor color) Sets the background color.
DataLabelsOptionsBuilder	setBackgroundColor(String color) Sets the background color.
DataLabelsOptionsBuilder	setBorderColor(BorderColorCallback borderColorCallback) Sets the border color callback.
DataLabelsOptionsBuilder	setBorderColor(IsColor color) Sets the border color.
DataLabelsOptionsBuilder	setBorderColor(String color) Sets the border color.
DataLabelsOptionsBuilder	setBorderRadius(double radius) Sets the border radius.
DataLabelsOptionsBuilder	setBorderRadius(RadiusCallback borderRadiusCallback) Sets the border radius callback.
DataLabelsOptionsBuilder	setBorderWidth(BorderWidthCallback borderWidthCallback) Sets the border width callback.
DataLabelsOptionsBuilder	setBorderWidth(int width) Sets the border width.
DataLabelsOptionsBuilder	setClamp(boolean clamp) Sets true to enforce the anchor position to be calculated based on the visible geometry of the associated element (i.e.
DataLabelsOptionsBuilder	setClamp(ClampCallback clampCallback) Sets the clamp callback.
DataLabelsOptionsBuilder	setClickEventHandler(ClickEventHandler clickEventHandler) Sets the CLICK event (the mouse's primary button is pressed and released on a label) handler.
DataLabelsOptionsBuilder	setClip(boolean clip) When the clip option is true, the part of the label which is outside the chart area will be masked.
DataLabelsOptionsBuilder	setClip(ClipCallback clipCallback) Sets the clip callback.
DataLabelsOptionsBuilder	setColor(ColorCallback colorCallback) Sets the color callback.
DataLabelsOptionsBuilder	setColor(IsColor color) Sets the color.
DataLabelsOptionsBuilder	setColor(String color) Sets the color.
DataLabelsOptionsBuilder	setDisplay(boolean display) Sets the visibility of labels.
DataLabelsOptionsBuilder	setDisplay(Display display) Sets the visibility of labels.
DataLabelsOptionsBuilder	setDisplay(DisplayCallback displayCallback) Sets the display callback.
DataLabelsOptionsBuilder	setEnterEventHandler(EnterEventHandler enterEventHandler) Sets the ENTER event (the mouse is moved over a label) handler.
DataLabelsOptionsBuilder	setFont(FontCallback fontCallback) Sets the the font callback.
DataLabelsOptionsBuilder	setFontFamily(String fontFamily) Sets the font family, follows CSS font-family options.
DataLabelsOptionsBuilder	setFontLineHeight(double lineHeight) Sets the line height.
DataLabelsOptionsBuilder	setFontLineHeight(String lineHeight) Sets the line height.
DataLabelsOptionsBuilder	setFontSize(int fontSize) Sets the font size.
DataLabelsOptionsBuilder	setFontStyle(FontStyle fontStyle) Sets the font style, follows CSS font-style options (i.e.
DataLabelsOptionsBuilder	setFontWeight(Weight weight) Sets the font weight, follows CSS font-style-weight options.
DataLabelsOptionsBuilder	setFormatter(FormatterCallback formatterCallback) Sets the formatter callback.
DataLabelsOptionsBuilder	setLeaveEventHandler(LeaveEventHandler leaveEventHandler) Sets the LEAVE event (the mouse is moved out of a label) handler.
DataLabelsOptionsBuilder	setListenersHandler(AbstractEventHandler handler) Adds a event handler instance as listener for all events.
DataLabelsOptionsBuilder	setOffset(double offset) Sets the distance (in pixels) to pull the label away from the anchor point.
DataLabelsOptionsBuilder	setOffset(OffsetCallback offsetCallback) Sets the offset callback.
DataLabelsOptionsBuilder	setOpacity(double opacity) Sets the opacity.
DataLabelsOptionsBuilder	setOpacity(OpacityCallback opacityCallback) Sets the opacity callback.
DataLabelsOptionsBuilder	setPadding(int padding) Sets the padding size to all dimensions.
DataLabelsOptionsBuilder	setPadding(PaddingCallback paddingCallback) Sets the padding callback.
DataLabelsOptionsBuilder	setPaddingBottom(int padding) Sets the padding bottom in pixel.
DataLabelsOptionsBuilder	setPaddingLeft(int padding) Sets the padding left in pixel.
DataLabelsOptionsBuilder	setPaddingRight(int padding) Sets the padding right in pixel.
DataLabelsOptionsBuilder	setPaddingTop(int padding) Sets the padding top in pixel.
DataLabelsOptionsBuilder	setRotation(double rotation) Sets the clockwise rotation angle (in degrees) of the label, the rotation center point being the label center.
DataLabelsOptionsBuilder	setRotation(RotationCallback rotationCallback) Sets the rotation callback.
DataLabelsOptionsBuilder	setTextAlign(TextAlign textAlign) Sets the text alignment being used when drawing the label text.
DataLabelsOptionsBuilder	setTextAlign(TextAlignCallback textAlignCallback) Sets the text align callback.
DataLabelsOptionsBuilder	setTextShadowBlur(double textShadowBlur) Sets the text shadow blur.
DataLabelsOptionsBuilder	setTextShadowBlur(TextShadowBlurCallback textShadowBlurCallback) Sets the text shadow blur callback.
DataLabelsOptionsBuilder	setTextShadowColor(IsColor color) Sets the text shadow color color.
DataLabelsOptionsBuilder	setTextShadowColor(String color) Sets the text shadow color color.
DataLabelsOptionsBuilder	setTextShadowColor(TextShadowColorCallback textShadowColorCallback) Sets the text shadow color callback.
DataLabelsOptionsBuilder	setTextStrokeColor(IsColor color) Sets the text stroke color.
DataLabelsOptionsBuilder	setTextStrokeColor(String color) Sets the text stroke color.
DataLabelsOptionsBuilder	setTextStrokeColor(TextStrokeColorCallback textStrokeColorCallback) Sets the text stroke color callback.
DataLabelsOptionsBuilder	setTextStrokeWidth(int textStrokeWidth) Sets the text stroke width.
DataLabelsOptionsBuilder	setTextStrokeWidth(TextStrokeWidthCallback textStrokeWidthCallback) Sets the text stroke width callback.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static DataLabelsOptionsBuilder create()

Returns new builder instance.

Returns:

new builder instance

create

public static DataLabelsOptionsBuilder create(IsChart chart)

Returns new builder instance using the chart global options.

Parameters:

chart - chart instance related to the plugin options

Returns:

new builder instance

build

public DataLabelsOptions build()

Returns a configured labels options.

Returns:

a configured labels options.

setListenersHandler

public DataLabelsOptionsBuilder setListenersHandler(AbstractEventHandler handler)

Adds a event handler instance as listener for all events.

Parameters:

handler - event handler instance as listener for all events.

Returns:

builder instance

setAlign

public DataLabelsOptionsBuilder setAlign(Align align)

Sets the position of the label relative to the anchor point position and orientation.

Parameters:

align - the position of the label relative to the anchor point position and orientation.

Returns:

builder instance

setAnchor

public DataLabelsOptionsBuilder setAnchor(Anchor anchor)

Sets the anchor point, which is defined by an orientation vector and a position on the data element.

Parameters:

anchor - the anchor point, which is defined by an orientation vector and a position on the data element.

Returns:

builder instance

setBackgroundColor

public DataLabelsOptionsBuilder setBackgroundColor(IsColor color)

Sets the background color.

Parameters:

color - the background color

Returns:

builder instance

setBackgroundColor

public DataLabelsOptionsBuilder setBackgroundColor(String color)

Sets the background color.

Parameters:

color - the background color

Returns:

builder instance

setBorderColor

public DataLabelsOptionsBuilder setBorderColor(IsColor color)

Sets the border color.

Parameters:

color - the border color

Returns:

builder instance

setBorderColor

public DataLabelsOptionsBuilder setBorderColor(String color)

Sets the border color.

Parameters:

color - the border color

Returns:

builder instance

setBorderRadius

public DataLabelsOptionsBuilder setBorderRadius(double radius)

Sets the border radius.

Parameters:

radius - the border radius.

Returns:

builder instance

setBorderWidth

public DataLabelsOptionsBuilder setBorderWidth(int width)

Sets the border width.

Parameters:

width - the border width.

Returns:

builder instance

setClamp

public DataLabelsOptionsBuilder setClamp(boolean clamp)

Sets true to enforce the anchor position to be calculated based on the visible geometry of the associated element (i.e. part inside the chart area).

Parameters:

clamp - true to enforce the anchor position to be calculated based on the visible geometry of the associated element (i.e. part inside the chart area).

Returns:

builder instance

setClip

public DataLabelsOptionsBuilder setClip(boolean clip)

When the clip option is true, the part of the label which is outside the chart area will be masked.

Parameters:

clip - when the clip option is true, the part of the label which is outside the chart area will be masked.

Returns:

builder instance

setColor

public DataLabelsOptionsBuilder setColor(IsColor color)

Sets the color.

Parameters:

color - the color

Returns:

builder instance

setColor

public DataLabelsOptionsBuilder setColor(String color)

Sets the color.

Parameters:

color - the color

Returns:

builder instance

setDisplay

public DataLabelsOptionsBuilder setDisplay(boolean display)

Sets the visibility of labels.

Parameters:

display - the visibility of labels.

Returns:

builder instance

setDisplay

public DataLabelsOptionsBuilder setDisplay(Display display)

Sets the visibility of labels.

Parameters:

display - the visibility of labels.

Returns:

builder instance

setOffset

public DataLabelsOptionsBuilder setOffset(double offset)

Sets the distance (in pixels) to pull the label away from the anchor point. This option is not applicable when align is 'center'. Also note that if align is 'start', the label is moved in the opposite direction.

Parameters:

offset - the distance (in pixels) to pull the label away from the anchor point. This option is not applicable when align is 'center'. Also note that if align is 'start', the label is moved in the opposite direction.

Returns:

builder instance

setOpacity

public DataLabelsOptionsBuilder setOpacity(double opacity)

Sets the opacity.

Parameters:

opacity - the opacity.

Returns:

builder instance

setRotation

public DataLabelsOptionsBuilder setRotation(double rotation)

Sets the clockwise rotation angle (in degrees) of the label, the rotation center point being the label center.

Parameters:

rotation - the clockwise rotation angle (in degrees) of the label, the rotation center point being the label center.

Returns:

builder instance

setTextAlign

public DataLabelsOptionsBuilder setTextAlign(TextAlign textAlign)

Sets the text alignment being used when drawing the label text.

Parameters:

textAlign - the text alignment being used when drawing the label text.

Returns:

builder instance

setTextStrokeColor

public DataLabelsOptionsBuilder setTextStrokeColor(IsColor color)

Sets the text stroke color.

Parameters:

color - the text stroke color

Returns:

builder instance

setTextStrokeColor

public DataLabelsOptionsBuilder setTextStrokeColor(String color)

Sets the text stroke color.

Parameters:

color - the text stroke color.

Returns:

builder instance

setTextStrokeWidth

public DataLabelsOptionsBuilder setTextStrokeWidth(int textStrokeWidth)

Sets the text stroke width.

Parameters:

textStrokeWidth - the text stroke width.

Returns:

builder instance

setTextShadowBlur

public DataLabelsOptionsBuilder setTextShadowBlur(double textShadowBlur)

Sets the text shadow blur.

Parameters:

textShadowBlur - the text shadow blur.

Returns:

builder instance

setTextShadowColor

public DataLabelsOptionsBuilder setTextShadowColor(IsColor color)

Sets the text shadow color color.

Parameters:

color - the text shadow color color

Returns:

builder instance

setTextShadowColor

public DataLabelsOptionsBuilder setTextShadowColor(String color)

Sets the text shadow color color.

Parameters:

color - the text shadow color color.

Returns:

builder instance

setBackgroundColor

public DataLabelsOptionsBuilder setBackgroundColor(BackgroundColorCallback backgroundColorCallback)

Sets the background color callback.

Parameters:

backgroundColorCallback - the background color callback.

Returns:

builder instance

setBorderColor

public DataLabelsOptionsBuilder setBorderColor(BorderColorCallback borderColorCallback)

Sets the border color callback.

Parameters:

borderColorCallback - the border color callback.

Returns:

builder instance

setColor

public DataLabelsOptionsBuilder setColor(ColorCallback colorCallback)

Sets the color callback.

Parameters:

colorCallback - the color callback.

Returns:

builder instance

setFormatter

public DataLabelsOptionsBuilder setFormatter(FormatterCallback formatterCallback)

Sets the formatter callback.

Parameters:

formatterCallback - the formatter callback to set

Returns:

builder instance

setAlign

public DataLabelsOptionsBuilder setAlign(AlignCallback alignCallback)

Sets the align callback.

Parameters:

alignCallback - the align callback to set

Returns:

builder instance

setAnchor

public DataLabelsOptionsBuilder setAnchor(AnchorCallback anchorCallback)

Sets the anchor callback.

Parameters:

anchorCallback - the anchor callback to set

Returns:

builder instance

setBorderRadius

public DataLabelsOptionsBuilder setBorderRadius(RadiusCallback borderRadiusCallback)

Sets the border radius callback.

Parameters:

borderRadiusCallback - the border radius callback to set

Returns:

builder instance

setBorderWidth

public DataLabelsOptionsBuilder setBorderWidth(BorderWidthCallback borderWidthCallback)

Sets the border width callback.

Parameters:

borderWidthCallback - the border width callback to set

Returns:

builder instance

setClamp

public DataLabelsOptionsBuilder setClamp(ClampCallback clampCallback)

Sets the clamp callback.

Parameters:

clampCallback - the clamp callback to set

Returns:

builder instance

setClip

public DataLabelsOptionsBuilder setClip(ClipCallback clipCallback)

Sets the clip callback.

Parameters:

clipCallback - the clip callback to set

Returns:

builder instance

setDisplay

public DataLabelsOptionsBuilder setDisplay(DisplayCallback displayCallback)

Sets the display callback.

Parameters:

displayCallback - the display callback to set

Returns:

builder instance

setOffset

public DataLabelsOptionsBuilder setOffset(OffsetCallback offsetCallback)

Sets the offset callback.

Parameters:

offsetCallback - the offset callback to set

Returns:

builder instance

setOpacity

public DataLabelsOptionsBuilder setOpacity(OpacityCallback opacityCallback)

Sets the opacity callback.

Parameters:

opacityCallback - the opacity callback to set

Returns:

builder instance

setRotation

public DataLabelsOptionsBuilder setRotation(RotationCallback rotationCallback)

Sets the rotation callback.

Parameters:

rotationCallback - the rotation callback to set

Returns:

builder instance

setTextAlign

public DataLabelsOptionsBuilder setTextAlign(TextAlignCallback textAlignCallback)

Sets the text align callback.

Parameters:

textAlignCallback - the text align callback to set

Returns:

builder instance

setTextStrokeColor

public DataLabelsOptionsBuilder setTextStrokeColor(TextStrokeColorCallback textStrokeColorCallback)

Sets the text stroke color callback.

Parameters:

textStrokeColorCallback - the text stroke color callback to set

Returns:

builder instance

setTextStrokeWidth

public DataLabelsOptionsBuilder setTextStrokeWidth(TextStrokeWidthCallback textStrokeWidthCallback)

Sets the text stroke width callback.

Parameters:

textStrokeWidthCallback - the text stroke width callback to set

Returns:

builder instance

setTextShadowBlur

public DataLabelsOptionsBuilder setTextShadowBlur(TextShadowBlurCallback textShadowBlurCallback)

Sets the text shadow blur callback.

Parameters:

textShadowBlurCallback - the text shadow blur callback to set

Returns:

builder instance

setTextShadowColor

public DataLabelsOptionsBuilder setTextShadowColor(TextShadowColorCallback textShadowColorCallback)

Sets the text shadow color callback.

Parameters:

textShadowColorCallback - the text shadow color callback to set

Returns:

builder instance

setFont

public DataLabelsOptionsBuilder setFont(FontCallback fontCallback)

Sets the the font callback.

Parameters:

fontCallback - the font callback to set

Returns:

builder instance

setPadding

public DataLabelsOptionsBuilder setPadding(PaddingCallback paddingCallback)

Sets the padding callback.

Parameters:

paddingCallback - the padding callback to set

Returns:

builder instance

setFontSize

public DataLabelsOptionsBuilder setFontSize(int fontSize)

Sets the font size.

Parameters:

fontSize - the font size.

Returns:

builder instance

setFontStyle

public DataLabelsOptionsBuilder setFontStyle(FontStyle fontStyle)

Sets the font style, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

Parameters:

fontStyle - Font style, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

Returns:

builder instance

setFontFamily

public DataLabelsOptionsBuilder setFontFamily(String fontFamily)

Sets the font family, follows CSS font-family options.

Parameters:

fontFamily - Font family, follows CSS font-family options.

Returns:

builder instance

setFontWeight

public DataLabelsOptionsBuilder setFontWeight(Weight weight)

Sets the font weight, follows CSS font-style-weight options.

Parameters:

weight - font weight, follows CSS font-style-weight options.

Returns:

builder instance

setFontLineHeight

public DataLabelsOptionsBuilder setFontLineHeight(double lineHeight)

Sets the line height.

Parameters:

lineHeight - the line height.

Returns:

builder instance

setFontLineHeight

public DataLabelsOptionsBuilder setFontLineHeight(String lineHeight)

Sets the line height.

Parameters:

lineHeight - the line height.

Returns:

builder instance

setPadding

public DataLabelsOptionsBuilder setPadding(int padding)

Sets the padding size to all dimensions.

Parameters:

padding - padding size to apply to all dimensions.

Returns:

builder instance

setPaddingLeft

public DataLabelsOptionsBuilder setPaddingLeft(int padding)

Sets the padding left in pixel.

Parameters:

padding - the padding left in pixel.

Returns:

builder instance

setPaddingRight

public DataLabelsOptionsBuilder setPaddingRight(int padding)

Sets the padding right in pixel.

Parameters:

padding - the padding right in pixel.

Returns:

builder instance

setPaddingTop

public DataLabelsOptionsBuilder setPaddingTop(int padding)

Sets the padding top in pixel.

Parameters:

padding - the padding top in pixel.

Returns:

builder instance

setPaddingBottom

public DataLabelsOptionsBuilder setPaddingBottom(int padding)

Sets the padding bottom in pixel.

Parameters:

padding - the padding bottom in pixel.

Returns:

builder instance

setClickEventHandler

public DataLabelsOptionsBuilder setClickEventHandler(ClickEventHandler clickEventHandler)

Sets the CLICK event (the mouse's primary button is pressed and released on a label) handler.

Parameters:

clickEventHandler - the click event handler to set

Returns:

builder instance

setEnterEventHandler

public DataLabelsOptionsBuilder setEnterEventHandler(EnterEventHandler enterEventHandler)

Sets the ENTER event (the mouse is moved over a label) handler.

Parameters:

enterEventHandler - the enter event handler to set

Returns:

builder instance

setLeaveEventHandler

public DataLabelsOptionsBuilder setLeaveEventHandler(LeaveEventHandler leaveEventHandler)

Sets the LEAVE event (the mouse is moved out of a label) handler.

Parameters:

leaveEventHandler - the leave event handler to set

Returns:

builder instance