LegendItem (Charba - J2CL and GWT charts library based on CHART.JS)

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

Direct Known Subclasses:

LegendLabelItem
```
public class LegendItem
extends NativeObjectContainer
```
This is a wrapper of the CHART.JS item which contains the legend item.

Author:

Andrea "Stock" Stocchero

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LegendItem.LegendItemFactory
Inner class to create legend item by a native object.

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

Constructor Summary

Constructors
Constructor and Description

LegendItem(LegendItem item)
Creates the item using another legend item which contains all properties.

Constructors
Constructor and Description
`LegendItem(LegendItem item)` Creates the item using another legend item which contains all properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getDatasetIndex()` Returns the dataset index of the chart
`IsColor`	`getFillStyle()` Returns the fill style of the legend box as color.
`CanvasGradientItem`	`getFillStyleAsCanvasGradient()` Returns the fill style of the legend box as canvas gradient.
`CanvasPatternItem`	`getFillStyleAsCanvasPattern()` Returns the fill style of the legend box as canvas pattern.
`int`	`getIndex()` Returns the dataset index of the chart (for POLAR and PIE charts)
`CapStyle`	`getLineCap()` Returns how the end points of every box border are drawn.
`List<Integer>`	`getLineDash()` Returns 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.
`int`	`getLineDashOffset()` Returns the box border dash pattern offset or "phase".
`JoinStyle`	`getLineJoin()` Returns 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.
`int`	`getLineWidth()` Returns the width of line in pixels.
`PointStyle`	`getPointStyle()` Returns the style of the legend box (only used if usePointStyle is true)
`Img`	`getPointStyleAsImage()` Returns the style (as image) of the legend box (only used if usePointStyle is true)
`double`	`getRotation()` Returns the rotation of the point in degrees (only used if usePointStyle is true).
`IsColor`	`getStrokeStyle()` Returns the stroke style of the legend box as color.
`CanvasGradientItem`	`getStrokeStyleAsCanvasGradient()` Returns the stroke style of the legend box as gradient.
`CanvasPatternItem`	`getStrokeStyleAsCanvasPattern()` Returns the stroke style of the legend box as pattern.
`String`	`getText()` Returns the label that will be displayed
`boolean`	`isFillStyleAsCanvasGradient()` Returns `true` if the fill style is defined as gradient.
`boolean`	`isFillStyleAsCanvasPattern()` Returns `true` if the fill style is defined as canvas pattern.
`boolean`	`isFillStyleAsColor()` Returns `true` if the fill style is defined as color.
`boolean`	`isHidden()` Returns true if this item represents a hidden dataset.
`boolean`	`isPointStyleAsImage()` Returns `true` if the point style is defined as image.
`boolean`	`isStrokeStyleAsCanvasGradient()` Returns `true` if the stroke style is defined as gradient.
`boolean`	`isStrokeStyleAsCanvasPattern()` Returns `true` if the stroke style is defined as gradient.
`boolean`	`isStrokeStyleAsColor()` Returns `true` if the stroke style is defined as color.

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer
checkValue, empty, getArrayValue, getNativeChart, 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, setArrayValue, setValue, 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
  - LegendItem
```
public LegendItem(LegendItem item)
```
    Creates the item using another legend item which contains all properties.
    
    Parameters:
    
    item - legend item which contains all properties.
- Method Detail
  - getDatasetIndex
```
public final int getDatasetIndex()
```
    Returns the dataset index of the chart
    
    Returns:
    
    the dataset index of the chart. Default is UndefinedValues.INTEGER.
  - getIndex
```
public final int getIndex()
```
    Returns the dataset index of the chart (for POLAR and PIE charts)
    
    Returns:
    
    the dataset index of the chart (for POLAR and PIE charts). Default is UndefinedValues.INTEGER.
  - getText
```
public final String getText()
```
    Returns the label that will be displayed
    
    Returns:
    
    the label that will be displayed. Default is UndefinedValues.STRING.
  - isFillStyleAsColor
```
public final boolean isFillStyleAsColor()
```
    Returns true if the fill style is defined as color.
    
    Returns:
    
    true if the fill style is defined as color
  - isFillStyleAsCanvasGradient
```
public final boolean isFillStyleAsCanvasGradient()
```
    Returns true if the fill style is defined as gradient.
    
    Returns:
    
    true if the fill style is defined as gradient
  - isFillStyleAsCanvasPattern
```
public final boolean isFillStyleAsCanvasPattern()
```
    Returns true if the fill style is defined as canvas pattern.
    
    Returns:
    
    true if the fill style is defined as canvas pattern
  - getFillStyle
```
public final IsColor getFillStyle()
```
    Returns the fill style of the legend box as color.
    
    Returns:
    
    the fill style of the legend box or null if is not a color
  - getFillStyleAsCanvasGradient
```
public final CanvasGradientItem getFillStyleAsCanvasGradient()
```
    Returns the fill style of the legend box as canvas gradient.
    
    Returns:
    
    the fill style of the legend box or null if is not a canvas gradient
  - getFillStyleAsCanvasPattern
```
public final CanvasPatternItem getFillStyleAsCanvasPattern()
```
    Returns the fill style of the legend box as canvas pattern.
    
    Returns:
    
    the fill style of the legend box or null if is not a canvas pattern
  - isStrokeStyleAsColor
```
public final boolean isStrokeStyleAsColor()
```
    Returns true if the stroke style is defined as color.
    
    Returns:
    
    true if the stroke style is defined as color
  - isStrokeStyleAsCanvasGradient
```
public final boolean isStrokeStyleAsCanvasGradient()
```
    Returns true if the stroke style is defined as gradient.
    
    Returns:
    
    true if the stroke style is defined as gradient
  - isStrokeStyleAsCanvasPattern
```
public final boolean isStrokeStyleAsCanvasPattern()
```
    Returns true if the stroke style is defined as gradient.
    
    Returns:
    
    true if the stroke style is defined as gradient
  - getStrokeStyle
```
public final IsColor getStrokeStyle()
```
    Returns the stroke style of the legend box as color.
    
    Returns:
    
    the stroke style of the legend box or null if is not a color
  - getStrokeStyleAsCanvasGradient
```
public final CanvasGradientItem getStrokeStyleAsCanvasGradient()
```
    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
  - getStrokeStyleAsCanvasPattern
```
public final CanvasPatternItem getStrokeStyleAsCanvasPattern()
```
    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
  - isHidden
```
public final boolean isHidden()
```
    Returns true if this item represents a hidden dataset. Label will be rendered with a strike-through effect
    
    Returns:
    
    true if this item represents a hidden dataset. Label will be rendered with a strike-through effect.
    Default is UndefinedValues.BOOLEAN.
  - getLineCap
```
public final CapStyle getLineCap()
```
    Returns 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.
    
    Returns:
    
    how the end points of every box border are drawn.
  - getLineDash
```
public final List<Integer> getLineDash()
```
    Returns 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.
    
    Returns:
    
    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.
  - getLineDashOffset
```
public final int getLineDashOffset()
```
    Returns the box border dash pattern offset or "phase".
    
    Returns:
    
    the box border dash pattern offset or "phase".
  - getLineJoin
```
public final JoinStyle getLineJoin()
```
    Returns 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.
    
    Returns:
    
    There are three possible values for this property: round, bevel and miter.
  - getLineWidth
```
public final int getLineWidth()
```
    Returns the width of line in pixels.
    
    Returns:
    
    the width of line in pixels.
  - getRotation
```
public final double getRotation()
```
    Returns the rotation of the point in degrees (only used if usePointStyle is true).
    
    Returns:
    
    the rotation of the point in degrees
  - isPointStyleAsImage
```
public final boolean isPointStyleAsImage()
```
    Returns true if the point style is defined as image.
    
    Returns:
    
    true if the point style is defined as image
  - getPointStyle
```
public final PointStyle getPointStyle()
```
    Returns the style of the legend box (only used if usePointStyle is true)
    
    Returns:
    
    the style of the legend box
  - getPointStyleAsImage
```
public final Img 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

Class LegendItem

Nested Class Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

LegendItem

Method Detail

getDatasetIndex

getIndex

getText

isFillStyleAsColor

isFillStyleAsCanvasGradient

isFillStyleAsCanvasPattern

getFillStyle

getFillStyleAsCanvasGradient

getFillStyleAsCanvasPattern

isStrokeStyleAsColor

isStrokeStyleAsCanvasGradient

isStrokeStyleAsCanvasPattern

getStrokeStyle

getStrokeStyleAsCanvasGradient

getStrokeStyleAsCanvasPattern

isHidden

getLineCap

getLineDash

getLineDashOffset

getLineJoin

getLineWidth

getRotation

isPointStyleAsImage

getPointStyle

getPointStyleAsImage