LegendLabelItem (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.items.LegendItem
  - - org.pepstock.charba.client.items.LegendLabelItem

```
public final class LegendLabelItem
extends LegendItem
```
This object is created by callbacks and returned to HCART.JS as native object to configure the legend.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors
Constructor and Description

LegendLabelItem()
Standard constructor which wraps a new native java script object.

Constructors
Constructor and Description
`LegendLabelItem()` Standard constructor which wraps a new native java script object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getLineWidth()` Returns the width of line in pixels.
`PointStyle`	`getPointStyle()` Returns the style of the legend box (only used if usePointStyle is true)
`ImageElement`	`getPointStyleAsImage()` Returns the style (as image) of the legend box (only used if usePointStyle is true)
`IsColor`	`getStrokeStyle()` Returns the stroke style of the legend box
`boolean`	`isPointStyleAsImage()` Returns `true` if the point style is defined as image.
`void`	`setDatasetIndex(int datasetIndex)` Sets the dataset index of the chart
`void`	`setFillStyle(IsColor color)` Sets the fill style of the legend box
`void`	`setHidden(boolean hidden)` Sets true if this item represents a hidden dataset.
`void`	`setIndex(int index)` Sets the dataset index of the chart (for POLAR and PIE charts)
`void`	`setLineCap(CapStyle style)` Sets how the end points of every box border are drawn.
`void`	`setLineDash(List<Integer> lineDash)` Sets the box border dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
`void`	`setLineDashOffset(int lineDashOffset)` Sets the box border dash pattern offset or "phase".
`void`	`setLineJoin(JoinStyle style)` Sets how two connecting segments (of box border) 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). There are three possible values for this property: round, bevel and miter.
`void`	`setLineWidth(int lineWidths)` Sets the width of box border in pixels.
`void`	`setPointStyle(Image pointStyle)` Sets the style of the point as image.
`void`	`setPointStyle(ImageElement pointStyle)` Sets the style (as image) of the legend box (only used if usePointStyle is true)
`void`	`setPointStyle(ImageResource pointStyle)` Sets the style of the point as image.
`void`	`setPointStyle(PointStyle style)` Sets the style of the legend box (only used if usePointStyle is true)
`void`	`setRotation(double rotation)` Sets the rotation of the point in degrees (only used if usePointStyle is true).
`void`	`setStrokeStyle(IsColor color)` Sets the stroke style of the legend box
`void`	`setText(String text)` Sets the label that will be displayed

Methods inherited from class org.pepstock.charba.client.items.LegendItem
getDatasetIndex, getFillStyle, getIndex, getLineCap, getLineDash, getLineDashOffset, getLineJoin, getRotation, getText, isHidden

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer
checkValue, 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
  - LegendLabelItem
```
public LegendLabelItem()
```
    Standard constructor which wraps a new native java script object.
- Method Detail
  - setDatasetIndex
```
public void setDatasetIndex(int datasetIndex)
```
    Sets the dataset index of the chart
    
    Parameters:
    
    datasetIndex - the dataset index of the chart
  - setIndex
```
public void setIndex(int index)
```
    Sets the dataset index of the chart (for POLAR and PIE charts)
    
    Parameters:
    
    index - the dataset index of the chart (for POLAR and PIE charts)
  - setText
```
public void setText(String text)
```
    Sets the label that will be displayed
    
    Parameters:
    
    text - the label that will be displayed
  - setFillStyle
```
public void setFillStyle(IsColor color)
```
    Sets the fill style of the legend box
    
    Parameters:
    
    color - the fill style of the legend box
  - setHidden
```
public void setHidden(boolean hidden)
```
    Sets true if this item represents a hidden dataset. Label will be rendered with a strike-through effect
    
    Parameters:
    
    hidden - true if this item represents a hidden dataset. Label will be rendered with a strike-through effect
  - setLineCap
```
public void setLineCap(CapStyle style)
```
    Sets how the end points of every box border are drawn. There are three possible values for this property and those are: butt, round and square.
    
    Parameters:
    
    style - how the end points of every box border are drawn.
  - setLineDash
```
public void setLineDash(List<Integer> lineDash)
```
    Sets the box border dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
    
    Parameters:
    
    lineDash - the box border dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
  - setLineDashOffset
```
public void setLineDashOffset(int lineDashOffset)
```
    Sets the box border dash pattern offset or "phase".
    
    Parameters:
    
    lineDashOffset - the box border dash pattern offset or "phase".
  - setLineJoin
```
public void setLineJoin(JoinStyle style)
```
    Sets how two connecting segments (of box border) 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).
    There are three possible values for this property: round, bevel and miter.
    
    Parameters:
    
    style - There are three possible values for this property: round, bevel and miter.
  - setLineWidth
```
public void setLineWidth(int lineWidths)
```
    Sets the width of box border in pixels.
    
    Parameters:
    
    lineWidths - the width of box border in pixels.
  - getLineWidth
```
public int getLineWidth()
```
    Returns the width of line in pixels.
    
    Returns:
    
    the width of line in pixels.
  - setStrokeStyle
```
public void setStrokeStyle(IsColor color)
```
    Sets the stroke style of the legend box
    
    Parameters:
    
    color - the stroke style of the legend box
  - getStrokeStyle
```
public IsColor getStrokeStyle()
```
    Returns the stroke style of the legend box
    
    Returns:
    
    the stroke style of the legend box
  - isPointStyleAsImage
```
public boolean isPointStyleAsImage()
```
    Returns true if the point style is defined as image.
    
    Returns:
    
    true if the point style is defined as image
  - setPointStyle
```
public void setPointStyle(PointStyle style)
```
    Sets the style of the legend box (only used if usePointStyle is true)
    
    Parameters:
    
    style - the style of the legend box
  - setPointStyle
```
public void setPointStyle(ImageResource pointStyle)
```
    Sets the style of the point as image.
    
    Parameters:
    
    pointStyle - image resource of the style of the point as image.
  - setPointStyle
```
public void setPointStyle(Image pointStyle)
```
    Sets the style of the point as image.
    
    Parameters:
    
    pointStyle - image resource of the style of the point as image.
  - setPointStyle
```
public void setPointStyle(ImageElement pointStyle)
```
    Sets the style (as image) of the legend box (only used if usePointStyle is true)
    
    Parameters:
    
    pointStyle - the style (as image) of the legend box
  - getPointStyle
```
public PointStyle getPointStyle()
```
    Returns the style of the legend box (only used if usePointStyle is true)
    
    Returns:
    
    the style of the legend box
  - getPointStyleAsImage
```
public ImageElement getPointStyleAsImage()
```
    Returns the style (as image) of the legend box (only used if usePointStyle is true)
    
    Returns:
    
    the style (as image) of the legend box
  - setRotation
```
public void setRotation(double rotation)
```
    Sets the rotation of the point in degrees (only used if usePointStyle is true).
    
    Parameters:
    
    rotation - the rotation of the point in degrees

Class LegendLabelItem

Constructor Summary

Method Summary

Methods inherited from class org.pepstock.charba.client.items.LegendItem

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

Methods inherited from class java.lang.Object

Constructor Detail

LegendLabelItem

Method Detail

setDatasetIndex

setIndex

setText

setFillStyle

setHidden

setLineCap

setLineDash

setLineDashOffset

setLineJoin

setLineWidth

getLineWidth

setStrokeStyle

getStrokeStyle

isPointStyleAsImage

setPointStyle

setPointStyle

setPointStyle

setPointStyle

getPointStyle

getPointStyleAsImage

setRotation