LegendLabelItem (Charba - GWT Charts library based on 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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LegendLabelItem.LegendLabelItemFactory
Inner class to create legend label item by a native object.
- Nested classes/interfaces inherited from class org.pepstock.charba.client.items.LegendItem
  LegendItem.LegendItemFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`LegendLabelItem.LegendLabelItemFactory` Inner class to create legend label item by a native object.

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
`Gradient`	`getFillStyleAsGradient()` Returns the fill style of the legend box as gradient.
`Pattern`	`getFillStyleAsPattern()` Returns the fill style of the legend box as pattern.
`Gradient`	`getStrokeStyleAsGradient()` Returns the stroke style of the legend box as gradient.
`Pattern`	`getStrokeStyleAsPattern()` Returns the stroke style of the legend box as pattern.
`SafeHtml`	`getTextAsHtml()` Returns the label that will be displayed, as HTML. If is not HTML, returns `UndefinedValues.STRING`.
`boolean`	`isHtmlText()` Returns `true` if the text of legend item is HTML. This field is used ONLY by `HtmlLegend` plugin and not by CHART.js.
`void`	`setDatasetIndex(int datasetIndex)` Sets the dataset index of the chart.
`void`	`setFillStyle(CanvasGradient gradient)` Sets the fill style of the legend box as canvas gradient.
`void`	`setFillStyle(CanvasPattern pattern)` Sets the fill style of the legend box as canvas pattern.
`void`	`setFillStyle(IsChart chart, Gradient gradient)` Sets the fill style of the legend box as gradient.
`void`	`setFillStyle(IsChart chart, Pattern pattern)` Sets the fill style of the legend box as pattern.
`void`	`setFillStyle(IsColor color)` Sets the fill style of the legend box as color.
`void`	`setFillStyle(String color)` Sets the fill style of the legend box as color.
`void`	`setHidden(boolean hidden)` Sets true if this item represents a hidden dataset.
`void`	`setHtmlText(boolean htmlText)` Sets `true` if the text of legend item is HTML. This field is used ONLY by `HtmlLegend` plugin and not by CHART.js.
`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 lineWidth)` 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(CanvasGradient gradient)` Sets the stroke style of the legend box as canvas gradient.
`void`	`setStrokeStyle(CanvasPattern pattern)` Sets the stroke style of the legend box as canvas pattern.
`void`	`setStrokeStyle(IsChart chart, Gradient gradient)` Sets the stroke style of the legend box as gradient.
`void`	`setStrokeStyle(IsChart chart, Pattern pattern)` Sets the stroke style of the legend box as pattern.
`void`	`setStrokeStyle(IsColor color)` Sets the stroke style of the legend box as color.
`void`	`setStrokeStyle(String color)` Sets the stroke style of the legend box as color.
`void`	`setText(SafeHtml text)` Sets the label that will be displayed, as HTML. This field is used ONLY by `HtmlLegend` plugin and not by CHART.js.
`void`	`setText(String text)` Sets the label that will be displayed.

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer
checkValue, empty, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, 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
  - setText
```
public void setText(SafeHtml text)
```
    Sets the label that will be displayed, as HTML.
    This field is used ONLY by HtmlLegend plugin and not by CHART.js.
    
    Parameters:
    
    text - the label that will be displayed, as HTML
  - isHtmlText
```
public boolean isHtmlText()
```
    Returns true if the text of legend item is HTML.
    This field is used ONLY by HtmlLegend plugin and not by CHART.js.
    
    Returns:
    
    true if the text of legend item is HTML
  - getTextAsHtml
```
public SafeHtml getTextAsHtml()
```
    Returns the label that will be displayed, as HTML.
    If is not HTML, returns UndefinedValues.STRING. This field is used ONLY by HtmlLegend plugin and not by CHART.js.
    
    Returns:
    
    the label that will be displayed, as HTML. Default is null.
  - setHtmlText
```
public void setHtmlText(boolean htmlText)
```
    Sets true if the text of legend item is HTML.
    This field is used ONLY by HtmlLegend plugin and not by CHART.js.
    
    Parameters:
    
    htmlText - true if the text of legend item is HTML
  - setFillStyle
```
public void setFillStyle(IsColor color)
```
    Sets the fill style of the legend box as color.
    
    Parameters:
    
    color - the fill style of the legend box as color
  - setFillStyle
```
public void setFillStyle(String color)
```
    Sets the fill style of the legend box as color.
    
    Parameters:
    
    color - the fill style of the legend box as color
  - setFillStyle
```
public void setFillStyle(CanvasPattern pattern)
```
    Sets the fill style of the legend box as canvas pattern.
    
    Parameters:
    
    pattern - the fill style of the legend box as canvas pattern
  - setFillStyle
```
public void setFillStyle(IsChart chart,
                         Pattern pattern)
```
    Sets the fill style of the legend box as pattern.
    
    Parameters:
    
    chart - chart instance related to this legend
    
    pattern - the fill style of the legend box as pattern
  - getFillStyleAsPattern
```
public Pattern getFillStyleAsPattern()
```
    Returns the fill style of the legend box as pattern.
    
    Returns:
    
    the fill style of the legend box or null if is not a pattern
  - setFillStyle
```
public void setFillStyle(CanvasGradient gradient)
```
    Sets the fill style of the legend box as canvas gradient.
    
    Parameters:
    
    gradient - the fill style of the legend box as canvas gradient
  - setFillStyle
```
public void setFillStyle(IsChart chart,
                         Gradient gradient)
```
    Sets the fill style of the legend box as gradient.
    
    Parameters:
    
    chart - chart instance related to this legend
    
    gradient - the fill style of the legend box as gradient
  - getFillStyleAsGradient
```
public Gradient getFillStyleAsGradient()
```
    Returns the fill style of the legend box as gradient.
    
    Returns:
    
    the fill style of the legend box or null if is not a gradient
  - 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 lineWidth)
```
    Sets the width of box border in pixels.
    
    Parameters:
    
    lineWidth - the width of box border in pixels.
  - setStrokeStyle
```
public void setStrokeStyle(IsColor color)
```
    Sets the stroke style of the legend box as color.
    
    Parameters:
    
    color - the stroke style of the legend box as color
  - setStrokeStyle
```
public void setStrokeStyle(String color)
```
    Sets the stroke style of the legend box as color.
    
    Parameters:
    
    color - the stroke style of the legend box as color
  - setStrokeStyle
```
public void setStrokeStyle(CanvasPattern pattern)
```
    Sets the stroke style of the legend box as canvas pattern.
    
    Parameters:
    
    pattern - the stroke style of the legend box as canvas pattern
  - setStrokeStyle
```
public void setStrokeStyle(IsChart chart,
                           Pattern pattern)
```
    Sets the stroke style of the legend box as pattern.
    
    Parameters:
    
    chart - chart instance related to this legend
    
    pattern - the stroke style of the legend box as pattern
  - getStrokeStyleAsPattern
```
public Pattern getStrokeStyleAsPattern()
```
    Returns the stroke style of the legend box as pattern.
    
    Returns:
    
    the stroke style of the legend box or null if is not a pattern
  - setStrokeStyle
```
public void setStrokeStyle(CanvasGradient gradient)
```
    Sets the stroke style of the legend box as canvas gradient.
    
    Parameters:
    
    gradient - the stroke style of the legend box as canvas gradient
  - setStrokeStyle
```
public void setStrokeStyle(IsChart chart,
                           Gradient gradient)
```
    Sets the stroke style of the legend box as gradient.
    
    Parameters:
    
    chart - chart instance related to this legend
    
    gradient - the stroke style of the legend box as gradient
  - getStrokeStyleAsGradient
```
public Gradient getStrokeStyleAsGradient()
```
    Returns the stroke style of the legend box as gradient.
    
    Returns:
    
    the stroke style of the legend box or null if is not a gradient
  - 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
  - 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

Nested Class Summary

Nested classes/interfaces inherited from class org.pepstock.charba.client.items.LegendItem

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

setText

isHtmlText

getTextAsHtml

setHtmlText

setFillStyle

setFillStyle

setFillStyle

setFillStyle

getFillStyleAsPattern

setFillStyle

setFillStyle

getFillStyleAsGradient

setHidden

setLineCap

setLineDash

setLineDashOffset

setLineJoin

setLineWidth

setStrokeStyle

setStrokeStyle

setStrokeStyle

setStrokeStyle

getStrokeStyleAsPattern

setStrokeStyle

setStrokeStyle

getStrokeStyleAsGradient

setPointStyle

setPointStyle

setPointStyle

setPointStyle

setRotation