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 Boolean	display
protected Boolean	fullWidth
protected LegendLabels	labels
protected JavaScriptFunction	onClick
protected Legend.Position	position

Constructor Summary

Constructors

Constructor	Description
Legend()

Method Summary

Modifier and Type	Method	Description
Boolean	getDisplay()
Boolean	getFullWidth()
LegendLabels	getLabels()
JavaScriptFunction	getOnClick()
Legend.Position	getPosition()
Legend	setDisplay(Boolean display)	Default true
Legend	setFullWidth(Boolean fullWidth)	Default true
Legend	setLabels(LegendLabels labels)	Default -
Legend	setOnClick(JavaScriptFunction onClick)	Default function(event, legendItem) {}
Legend	setPosition(Legend.Position position)	Default 'top'

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

fullWidth

protected Boolean fullWidth

onClick

protected JavaScriptFunction onClick

labels

protected LegendLabels labels

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'

getFullWidth

public Boolean getFullWidth()

See Also:

• setFullWidth(Boolean)

setFullWidth

public Legend setFullWidth(Boolean fullWidth)

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)

Default function(event, legendItem) {}

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

getLabels

public LegendLabels getLabels()

See Also:

• setLabels(LegendLabels)

setLabels

public Legend setLabels(LegendLabels labels)

Default -

See the Legend Label Configuration section below.