org.pepstock.charba.client.items

Class LegendItem

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

Constructor Summary

Constructors

Constructor and Description
LegendItem(NativeObject nativeObject) Creates the item using a native java script object which contains all properties.

Method Summary

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
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.
double	getRotation() Returns the rotation of the point in degrees (only used if usePointStyle is true).
String	getText() Returns the label that will be displayed
boolean	isHidden() Returns true if this item represents a hidden dataset.

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

LegendItem

public LegendItem(NativeObject nativeObject)

Creates the item using a native java script object which contains all properties.

Parameters:

nativeObject - native java script object 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.

getFillStyle

public final IsColor getFillStyle()

Returns the fill style of the legend box

Returns:

the fill style of the legend box

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.

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