LabelsOptions (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.plugins.AbstractPluginOptions
  - - org.pepstock.charba.client.labels.LabelsOptions

```
public final class LabelsOptions
extends AbstractPluginOptions
```
This is the object to map the LABELS plugin options, both at chart and global level.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors
Constructor and Description

LabelsOptions()
Creates an empty object with plugin options.

Constructors
Constructor and Description
`LabelsOptions()` Creates an empty object with plugin options.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IsColor`	`getFontColor()` Returns the the font color as color.
`String`	`getFontColorAsString()` Returns the the font color as string.
`FontColorCallback<?>`	`getFontColorCallback()` Returns the font color callback, if set, otherwise `null`.
`String`	`getFontFamily()` Returns the font family.
`int`	`getFontSize()` Returns the the font size.
`FontStyle`	`getFontStyle()` Returns the font style.
`List<ImageElement>`	`getImages()` Returns the images when `Render` is `Render.image`.
`int`	`getOutsidePadding()` Returns the padding when position is `Position.outside`.
`Position`	`getPosition()` Returns the position to draw label.
`int`	`getPrecision()` Returns the precision for percentage.
`Render`	`getRender()` Returns what data must be showed.
`RenderCallback<?>`	`getRenderCallback()` Returns the render callback, if set, otherwise `null`.
`int`	`getShadowBlur()` Returns the text shadow intensity.
`IsColor`	`getShadowColor()` Returns the text shadow color as color.
`String`	`getShadowColorAsString()` Returns the text shadow color as string.
`int`	`getShadowOffsetX()` Returns the text shadow X offset.
`int`	`getShadowOffsetY()` Returns the text shadow Y offset.
`int`	`getTextMargin()` Returns the margin of text when position is `Position.outside` or `Position.border`.
`boolean`	`isArc()` Returns if draws label in arc.
`boolean`	`isOverlap()` Returns if draws label even it's overlap.
`boolean`	`isShowActualPercentages()` Returns if shows the real calculated percentages from the values and don't apply the additional logic to fit the percentages to 100 in total.
`boolean`	`isShowZero()` Returns whether or not labels of value 0 are displayed.
`boolean`	`isTextShadow()` Returns if draws text shadows under labels.
`protected void`	`register()` Registers the options to the factory to manage the cache of options.
`void`	`setArc(boolean arc)` Sets if draws label in arc.
`void`	`setFontColor(FontColorCallback<?> fontColorCallback)` Sets the font color callback.
`void`	`setFontColor(IsColor color)` Sets the font color as color.
`void`	`setFontColor(String color)` Sets the font color as string.
`void`	`setFontFamily(String fontFamily)` Sets the font family
`void`	`setFontSize(int size)` Sets the font size.
`void`	`setFontStyle(FontStyle fontStyle)` Sets the font style.
`void`	`setImages(Image... images)` Sets the images when `Render` is `Render.image`.
`void`	`setImages(ImageElement... images)` Sets the images when `Render` is `Render.image`.
`void`	`setImages(ImageResource... images)` Sets the images when `Render` is `Render.image`.
`void`	`setOutsidePadding(int outsidePadding)` Sets the padding when position is `Position.outside`.
`void`	`setOverlap(boolean overlap)` Sets if draws label even it's overlap.
`void`	`setPosition(Position position)` + Sets the position to draw label.
`void`	`setPrecision(int precision)` Sets the precision for percentage.
`void`	`setRender(Render render)` Sets what data must be showed.
`void`	`setRender(RenderCallback<?> renderCallback)` Sets the render callback.
`void`	`setShadowBlur(int shadowBlur)` Sets the text shadow intensity.
`void`	`setShadowColor(IsColor shadowColor)` Sets the text shadow color as color.
`void`	`setShadowColor(String shadowColor)` Sets the text shadow color as string.
`void`	`setShadowOffsetX(int shadowOffsetX)` Sets the text shadow X offset.
`void`	`setShadowOffsetY(int shadowOffsetY)` Sets the text shadow Y offset.
`void`	`setShowActualPercentages(boolean showActualPercentages)` Sets if shows the real calculated percentages from the values and don't apply the additional logic to fit the percentages to 100 in total.
`void`	`setShowZero(boolean showZero)` Sets whether or not labels of value 0 are displayed.
`void`	`setTextMargin(int textMargin)` Sets the margin of text when position is `Position.outside` or `Position.border`.
`void`	`setTextShadow(boolean textShadow)` Sets if draws text shadows under labels.

Methods inherited from class org.pepstock.charba.client.plugins.AbstractPluginOptions
getId, getPluginId, getReferences

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer
getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LabelsOptions
```
public LabelsOptions()
```
    Creates an empty object with plugin options.
- Method Detail
  - register
```
protected void register()
```
    Description copied from class: AbstractPluginOptions
    
    Registers the options to the factory to manage the cache of options.
    
    Overrides:
    
    register in class AbstractPluginOptions
  - setRender
```
public final void setRender(Render render)
```
    Sets what data must be showed.
    
    Parameters:
    
    render - what data must be showed.
  - getRender
```
public final Render getRender()
```
    Returns what data must be showed.
    
    Returns:
    
    what data must be showed. Default is Render.value.
  - setPrecision
```
public final void setPrecision(int precision)
```
    Sets the precision for percentage.
    
    Parameters:
    
    precision - the precision for percentage
  - getPrecision
```
public final int getPrecision()
```
    Returns the precision for percentage.
    
    Returns:
    
    the precision for percentage. Default is 0.
  - setShowZero
```
public final void setShowZero(boolean showZero)
```
    Sets whether or not labels of value 0 are displayed.
    
    Parameters:
    
    showZero - whether or not labels of value 0 are displayed.
  - isShowZero
```
public final boolean isShowZero()
```
    Returns whether or not labels of value 0 are displayed.
    
    Returns:
    
    whether or not labels of value 0 are displayed. Default is false.
  - setFontSize
```
public final void setFontSize(int size)
```
    Sets the font size.
    
    Parameters:
    
    size - the font size.
  - getFontSize
```
public final int getFontSize()
```
    Returns the the font size.
    
    Returns:
    
    the font size. Default is Defaults.get().getGlobal().getDefaultFontSize().
  - setFontColor
```
public final void setFontColor(IsColor color)
```
    Sets the font color as color.
    
    Parameters:
    
    color - the font color as color.
  - setFontColor
```
public final void setFontColor(String color)
```
    Sets the font color as string.
    
    Parameters:
    
    color - the font color as string.
  - getFontColorAsString
```
public final String getFontColorAsString()
```
    Returns the the font color as string.
    
    Returns:
    
    the font color. Default is Defaults.get().getGlobal().getDefaultFontColorAsString(), even if the font color callback has been set.
  - getFontColor
```
public final IsColor getFontColor()
```
    Returns the the font color as color.
    
    Returns:
    
    the font color.
  - setFontStyle
```
public final void setFontStyle(FontStyle fontStyle)
```
    Sets the font style.
    
    Parameters:
    
    fontStyle - the font style.
  - getFontStyle
```
public final FontStyle getFontStyle()
```
    Returns the font style.
    
    Returns:
    
    the font style. Default is Defaults.get().getGlobal().getDefaultFontStyle().
  - setFontFamily
```
public final void setFontFamily(String fontFamily)
```
    Sets the font family
    
    Parameters:
    
    fontFamily - the font family
  - getFontFamily
```
public final String getFontFamily()
```
    Returns the font family.
    
    Returns:
    
    the font family. Default is Defaults.get().getGlobal().getDefaultFontFamily().
  - setTextShadow
```
public final void setTextShadow(boolean textShadow)
```
    Sets if draws text shadows under labels.
    
    Parameters:
    
    textShadow - true if draws text shadows under labels.
  - isTextShadow
```
public final boolean isTextShadow()
```
    Returns if draws text shadows under labels.
    
    Returns:
    
    true if draws text shadows under labels. Default is false.
  - setShadowBlur
```
public final void setShadowBlur(int shadowBlur)
```
    Sets the text shadow intensity.
    
    Parameters:
    
    shadowBlur - the text shadow intensity.
  - getShadowBlur
```
public final int getShadowBlur()
```
    Returns the text shadow intensity.
    
    Returns:
    
    the text shadow intensity. Default is 6.
  - setShadowOffsetX
```
public final void setShadowOffsetX(int shadowOffsetX)
```
    Sets the text shadow X offset.
    
    Parameters:
    
    shadowOffsetX - the text shadow X offset.
  - getShadowOffsetX
```
public final int getShadowOffsetX()
```
    Returns the text shadow X offset.
    
    Returns:
    
    the text shadow X offset. Default is 3.
  - setShadowOffsetY
```
public final void setShadowOffsetY(int shadowOffsetY)
```
    Sets the text shadow Y offset.
    
    Parameters:
    
    shadowOffsetY - the text shadow Y offset.
  - getShadowOffsetY
```
public final int getShadowOffsetY()
```
    Returns the text shadow Y offset.
    
    Returns:
    
    the text shadow Y offset. Default is 3.
  - setShadowColor
```
public final void setShadowColor(IsColor shadowColor)
```
    Sets the text shadow color as color.
    
    Parameters:
    
    shadowColor - the text shadow color as color.
  - setShadowColor
```
public final void setShadowColor(String shadowColor)
```
    Sets the text shadow color as string.
    
    Parameters:
    
    shadowColor - the text shadow color as string.
  - getShadowColorAsString
```
public final String getShadowColorAsString()
```
    Returns the text shadow color as string.
    
    Returns:
    
    the text shadow color as string. Default is rgba(0,0,0,0.3).
  - getShadowColor
```
public final IsColor getShadowColor()
```
    Returns the text shadow color as color.
    
    Returns:
    
    the text shadow color as color.
  - setArc
```
public final void setArc(boolean arc)
```
    Sets if draws label in arc. For bar chart this is ignored.
    
    Parameters:
    
    arc - if draws label in arc.
  - isArc
```
public final boolean isArc()
```
    Returns if draws label in arc.
    
    Returns:
    
    true if draws label in arc. Default is false.
  - setPosition
```
public final void setPosition(Position position)
```
    + Sets the position to draw label. For bar chart this is ignored.
    
    Parameters:
    
    position - the position to draw label.
  - getPosition
```
public final Position getPosition()
```
    Returns the position to draw label.
    
    Returns:
    
    the position to draw label. Default is Position.defaults.
  - setOverlap
```
public final void setOverlap(boolean overlap)
```
    Sets if draws label even it's overlap. For bar chart this is ignored.
    
    Parameters:
    
    overlap - if draws label even it's overlap.
  - isOverlap
```
public final boolean isOverlap()
```
    Returns if draws label even it's overlap.
    
    Returns:
    
    trueif draws label even it's overlap. Default is true.
  - setShowActualPercentages
```
public final void setShowActualPercentages(boolean showActualPercentages)
```
    Sets if shows the real calculated percentages from the values and don't apply the additional logic to fit the percentages to 100 in total.
    
    Parameters:
    
    showActualPercentages - if shows the real calculated percentages from the values and don't apply the additional logic to fit the percentages to 100 in total.
  - isShowActualPercentages
```
public final boolean isShowActualPercentages()
```
    Returns if shows the real calculated percentages from the values and don't apply the additional logic to fit the percentages to 100 in total.
    
    Returns:
    
    trueif shows the real calculated percentages from the values and don't apply the additional logic to fit the percentages to 100 in total. Default is false.
  - setOutsidePadding
```
public final void setOutsidePadding(int outsidePadding)
```
    Sets the padding when position is Position.outside.
    
    Parameters:
    
    outsidePadding - the padding when position is Position.outside.
  - getOutsidePadding
```
public final int getOutsidePadding()
```
    Returns the padding when position is Position.outside.
    
    Returns:
    
    the padding when position is Position.outside. Default is 2.
  - setTextMargin
```
public final void setTextMargin(int textMargin)
```
    Sets the margin of text when position is Position.outside or Position.border.
    
    Parameters:
    
    textMargin - the margin of text when position is Position.outside or Position.border.
  - getTextMargin
```
public final int getTextMargin()
```
    Returns the margin of text when position is Position.outside or Position.border.
    
    Returns:
    
    the margin of text when position is Position.outside or Position.border. Default is 2.
  - setImages
```
public final void setImages(ImageResource... images)
```
    Sets the images when Render is Render.image.
    
    Parameters:
    
    images - images when Render is Render.image.
  - setImages
```
public final void setImages(Image... images)
```
    Sets the images when Render is Render.image.
    
    Parameters:
    
    images - images when Render is Render.image.
  - setImages
```
public final void setImages(ImageElement... images)
```
    Sets the images when Render is Render.image.
    
    Parameters:
    
    images - images when Render is Render.image.
  - getImages
```
public final List<ImageElement> getImages()
```
    Returns the images when Render is Render.image.
    
    Returns:
    
    the images when Render is Render.image or an empty list.
  - getRenderCallback
```
public RenderCallback<?> getRenderCallback()
```
    Returns the render callback, if set, otherwise null.
    
    Returns:
    
    the render callback, if set, otherwise null
  - setRender
```
public void setRender(RenderCallback<?> renderCallback)
```
    Sets the render callback.
    
    Parameters:
    
    renderCallback - the render callback to set
  - getFontColorCallback
```
public FontColorCallback<?> getFontColorCallback()
```
    Returns the font color callback, if set, otherwise null.
    
    Returns:
    
    the font color callback, if set, otherwise null
  - setFontColor
```
public void setFontColor(FontColorCallback<?> fontColorCallback)
```
    Sets the font color callback.
    
    Parameters:
    
    fontColorCallback - the font color callback.

Class LabelsOptions

Constructor Summary

Method Summary

Methods inherited from class org.pepstock.charba.client.plugins.AbstractPluginOptions

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

Methods inherited from class java.lang.Object

Constructor Detail

LabelsOptions

Method Detail

register

setRender

getRender

setPrecision

getPrecision

setShowZero

isShowZero

setFontSize

getFontSize

setFontColor

setFontColor

getFontColorAsString

getFontColor

setFontStyle

getFontStyle

setFontFamily

getFontFamily

setTextShadow

isTextShadow

setShadowBlur

getShadowBlur

setShadowOffsetX

getShadowOffsetX

setShadowOffsetY

getShadowOffsetY

setShadowColor

setShadowColor

getShadowColorAsString

getShadowColor

setArc

isArc

setPosition

getPosition

setOverlap

isOverlap

setShowActualPercentages

isShowActualPercentages

setOutsidePadding

getOutsidePadding

setTextMargin

getTextMargin

setImages

setImages

setImages

getImages

getRenderCallback

setRender

getFontColorCallback

setFontColor