Package org.pepstock.charba.client.items

Class LegendNode

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.items.BaseBoxItem

org.pepstock.charba.client.items.BaseBoxNodeItem<Position>

org.pepstock.charba.client.items.LegendNode

All Implemented Interfaces:

IsArea

public final class LegendNode
extends BaseBoxNodeItem<Position>

Wrapper of legend node of CHART.JS.
This is a wrapper of legend node of Chart (of CHART.JS).

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor	Description
LegendNode(ChartEnvelop<NativeObject> envelop)	Creates the item using an envelop with the native java script object which contains all properties.

Method Summary

Modifier and Type	Method	Description
List<Double>	getColumnHeights()	Returns the list of columns heights.
List<Double>	getColumnWidths()	Returns the list of columns widths.
List<LegendHitBoxItem>	getHitBoxes()	Returns the list of hit boxes of the legend.
List<LegendLabelItem>	getItems()	Returns the list of items of the legend.
List<Double>	getLineWidths()	Returns the list of line widths.
boolean	isDoughnutMode()	Returns if it is in doughnut mode.
boolean	isInside(NativeAbstractMouseEvent event)	Returns true if the chart event is inside of this box, otherwise false.
default boolean	isInside(NativeBaseEvent event)	Returns true if the chart event is inside of a chart element, otherwise false.
default boolean	isInside(HasNativeEvent container)	Returns true if the chart event is inside of this box, otherwise false.

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

getMaxHeight, getMaxWidth, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getWeight, isActive, isFullSize

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

getBottom, getHeight, getLeft, getRight, getTop, getWidth

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

checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, 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

LegendNode

public LegendNode(ChartEnvelop<NativeObject> envelop)

Creates the item using an envelop with the native java script object which contains all properties.

Parameters:

envelop - envelop with the native java script object which contains all properties.

Method Detail

isDoughnutMode

public boolean isDoughnutMode()

Returns if it is in doughnut mode.

Returns:

true it is in doughnut mode.

getLineWidths

public List<Double> getLineWidths()

Returns the list of line widths.

Returns:

the list of line widths.

getColumnWidths

public List<Double> getColumnWidths()

Returns the list of columns widths.

Returns:

the list of columns widths.

getColumnHeights

public List<Double> getColumnHeights()

Returns the list of columns heights.

Returns:

the list of columns heights.

getHitBoxes

public List<LegendHitBoxItem> getHitBoxes()

Returns the list of hit boxes of the legend.

Returns:

the list of hit boxes of the legend.

getItems

public List<LegendLabelItem> getItems()

Returns the list of items of the legend.

Returns:

the list of items of the legend.

isInside

public boolean isInside(NativeAbstractMouseEvent event)

Description copied from class: BaseBoxItem

Returns true if the chart event is inside of this box, otherwise false.

Overrides:

isInside in class BaseBoxItem

Parameters:

event - event to check if inside the box

Returns:

true if the chart event is inside of this box, otherwise false

isInside

public default boolean isInside(NativeBaseEvent event)

Returns true if the chart event is inside of a chart element, otherwise false.

Parameters:

event - event to check if inside of a chart element.

Returns:

true if the chart event is inside a chart element, otherwise false

isInside

public default boolean isInside(HasNativeEvent container)

Returns true if the chart event is inside of this box, otherwise false.

Parameters:

container - event container to check if inside the box

Returns:

true if the chart event is inside of this box, otherwise false