Package software.xdev.chartjs.model.options

Class Legend

java.lang.Object

software.xdev.chartjs.model.options.Legend

public class Legend
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Legend.Position

Field Summary

Fields

Modifier and Type	Field	Description
protected String	align
protected Boolean	display
protected Boolean	fullSize
protected LegendLabels	labels
protected Integer	maxHeight
protected Integer	maxWidth
protected JavaScriptFunction	onClick
protected JavaScriptFunction	onHover
protected JavaScriptFunction	onLeave
protected Legend.Position	position
protected Boolean	reverse
protected Boolean	rtl
protected String	textDirection
protected LegendTitle	title

Constructor Summary

Constructors

Constructor	Description
Legend()

Method Summary

Modifier and Type	Method	Description
String	getAlign()
Boolean	getDisplay()
Boolean	getFullSize()
LegendLabels	getLabels()
Integer	getMaxHeight()
Integer	getMaxWidth()
JavaScriptFunction	getOnClick()
JavaScriptFunction	getOnHover()
JavaScriptFunction	getOnLeave()
Legend.Position	getPosition()
Boolean	getReverse()
Boolean	getRtl()
String	getTextDirection()
LegendTitle	getTitle()
Legend	setAlign(String align)	Default 'center'.
Legend	setDisplay(Boolean display)	Default true
Legend	setFullSize(Boolean fullSize)	Default true
Legend	setLabels(LegendLabels labels)	Default -
Legend	setMaxHeight(Integer maxHeight)	Maximum height of the legend, in pixels
Legend	setMaxWidth(Integer maxWidth)	Maximum width of the legend, in pixels
Legend	setOnClick(JavaScriptFunction onClick)	A callback that is called when a click is registered on top of a label item
Legend	setOnHover(JavaScriptFunction onHover)	A callback that is called when a 'mousemove' event is registered on top of a label item
Legend	setOnLeave(JavaScriptFunction onLeave)	A callback that is called when a 'mousemove' event is registered outside of a previously hovered label item
Legend	setPosition(Legend.Position position)	Default 'top'
Legend	setReverse(Boolean reverse)	Default false
Legend	setRtl(Boolean rtl)	true for rendering the legends from right to left
Legend	setTextDirection(String textDirection)	This will force the text direction 'rtl' or 'ltr' on the canvas for rendering the legend, regardless of the css specified on the canvas
Legend	setTitle(LegendTitle title)

Methods inherited from class java.lang.Object

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

Field Details

display

protected Boolean display

position

protected Legend.Position position

align

protected String align

maxHeight

protected Integer maxHeight

maxWidth

protected Integer maxWidth

fullSize

protected Boolean fullSize

onClick

protected JavaScriptFunction onClick

onHover

protected JavaScriptFunction onHover

onLeave

protected JavaScriptFunction onLeave

reverse

protected Boolean reverse

labels

protected LegendLabels labels

rtl

protected Boolean rtl

textDirection

protected String textDirection

title

protected LegendTitle title

Constructor Details

Legend

public Legend()

Method Details

getDisplay

public Boolean getDisplay()

See Also:

• setDisplay(Boolean)

setDisplay

public Legend setDisplay(Boolean display)

Default true

Is the legend displayed

getPosition

public Legend.Position getPosition()

See Also:

• setPosition(Legend.Position)

setPosition

public Legend setPosition(Legend.Position position)

Default 'top'

Position of the legend. Options are 'top' or 'bottom'

getAlign

public String getAlign()

See Also:

• setAlign(String)

setAlign

public Legend setAlign(String align)

Default 'center'.

Alignment of the legend

getMaxHeight

public Integer getMaxHeight()

See Also:

• setMaxHeight(Integer)

setMaxHeight

public Legend setMaxHeight(Integer maxHeight)

Maximum height of the legend, in pixels

getMaxWidth

public Integer getMaxWidth()

See Also:

• setMaxWidth(Integer)

setMaxWidth

public Legend setMaxWidth(Integer maxWidth)

Maximum width of the legend, in pixels

getFullSize

public Boolean getFullSize()

See Also:

• setFullSize(Boolean)

setFullSize

public Legend setFullSize(Boolean fullSize)

Default true

Marks that this box should take the full width of the canvas (pushing down other boxes)

getOnClick

public JavaScriptFunction getOnClick()

See Also:

• setOnClick(JavaScriptFunction)

setOnClick

public Legend setOnClick(JavaScriptFunction onClick)

A callback that is called when a click is registered on top of a label item

getOnHover

public JavaScriptFunction getOnHover()

See Also:

• setOnHover(JavaScriptFunction)

setOnHover

public Legend setOnHover(JavaScriptFunction onHover)

A callback that is called when a 'mousemove' event is registered on top of a label item

getOnLeave

public JavaScriptFunction getOnLeave()

See Also:

• setOnLeave(JavaScriptFunction)

setOnLeave

public Legend setOnLeave(JavaScriptFunction onLeave)

A callback that is called when a 'mousemove' event is registered outside of a previously hovered label item

getReverse

public Boolean getReverse()

See Also:

• setReverse(Boolean)

setReverse

public Legend setReverse(Boolean reverse)

Default false

Legend will show datasets in reverse order

getLabels

public LegendLabels getLabels()

See Also:

• setLabels(LegendLabels)

setLabels

public Legend setLabels(LegendLabels labels)

Default -

See the Legend Label Configuration section below.

getRtl

public Boolean getRtl()

See Also:

• setRtl(Boolean)

setRtl

public Legend setRtl(Boolean rtl)

true for rendering the legends from right to left

getTextDirection

public String getTextDirection()

See Also:

• setTextDirection(String)

setTextDirection

public Legend setTextDirection(String textDirection)

This will force the text direction 'rtl' or 'ltr' on the canvas for rendering the legend, regardless of the css specified on the canvas

getTitle

public LegendTitle getTitle()

See Also:

• setTitle(LegendTitle)

setTitle

public Legend setTitle(LegendTitle title)

See Also:

• LegendTitle