org.pepstock.charba.client.items

Class LegendItem

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.items.LegendItem

Direct Known Subclasses:

LegendLabelItem

public class LegendItem
extends JavaScriptObjectContainer

JavaScript object which contains the legends hit box size.

Author:

Andrea "Stock" Stocchero

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	LegendItem.Property Name of fields of JavaScript object.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LegendItem() Standard constructor which wraps a new java script object.
	LegendItem(GenericJavaScriptObject javaScriptObject) Wraps the CHART.JS java script object.

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.
java.util.List<java.lang.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 endpoints and control points are exactly at the same position, are skipped). There are three possible values for this property: round, bevel and miter.
java.util.List<java.lang.Integer>	getLineWidth() Returns the width of line in pixels.
java.util.List<PointStyle>	getPointStyle() Returns the style of the legend box (only used if usePointStyle is true)
java.util.List<IsColor>	getStrokeStyle() Returns the stroke style of the legend box
java.lang.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.JavaScriptObjectContainer

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LegendItem

protected LegendItem()

Standard constructor which wraps a new java script object.

LegendItem

public LegendItem(GenericJavaScriptObject javaScriptObject)

Wraps the CHART.JS java script object.

Parameters:

javaScriptObject - CHART.JS java script object

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.

See Also:

Data.getDatasets()

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.

See Also:

Data.getDatasets()

getText

public final java.lang.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.

See Also:

CapStyle

getLineDash

public final java.util.List<java.lang.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". Default is UndefinedValues.INTEGER.

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 endpoints 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.

See Also:

JoinStyle

getLineWidth

public final java.util.List<java.lang.Integer> getLineWidth()

Returns the width of line in pixels.

Returns:

the width of line in pixels.

getStrokeStyle

public final java.util.List<IsColor> getStrokeStyle()

Returns the stroke style of the legend box

Returns:

the stroke style of the legend box

getPointStyle

public final java.util.List<PointStyle> getPointStyle()

Returns the style of the legend box (only used if usePointStyle is true)

Returns:

the style of the legend box

See Also:

PointStyle