Package software.xdev.chartjs.model.options

Class LegendLabels

java.lang.Object

software.xdev.chartjs.model.options.LegendLabels

public class LegendLabels
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	boxWidth
protected Object	fontColor
protected String	fontFamily
protected Integer	fontSize
protected FontStyle	fontStyle
protected JavaScriptFunction	generateLabels
protected Integer	padding
protected Boolean	usePointStyle

Constructor Summary

Constructors

Constructor	Description
LegendLabels()

Method Summary

Modifier and Type	Method	Description
Integer	getBoxWidth()
Object	getFontColor()
String	getFontFamily()
Integer	getFontSize()
FontStyle	getFontStyle()
JavaScriptFunction	getGenerateLabels()
Integer	getPadding()
Boolean	getUsePointStyle()
LegendLabels	setBoxWidth(Integer boxWidth)	Width of coloured box
LegendLabels	setFontColor(Object fontColor)	Font color inherited from global configuration
LegendLabels	setFontFamily(String fontFamily)	Font family inherited from global configuration
LegendLabels	setFontSize(Integer fontSize)	Font size inherited from global configuration
LegendLabels	setFontStyle(FontStyle fontStyle)	Font style inherited from global configuration
LegendLabels	setGenerateLabels(JavaScriptFunction generateLabels)	Generates legend items for each thing in the legend.
LegendLabels	setPadding(Integer padding)	Padding between rows of colored boxes
LegendLabels	setUsePointStyle(Boolean usePointStyle)	Label style will match corresponding point style (size is based on fontSize, boxWidth is not used in this case).

Methods inherited from class java.lang.Object

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

Field Details

boxWidth

protected Integer boxWidth

fontSize

protected Integer fontSize

fontStyle

protected FontStyle fontStyle

fontColor

protected Object fontColor

fontFamily

protected String fontFamily

padding

protected Integer padding

generateLabels

protected JavaScriptFunction generateLabels

usePointStyle

protected Boolean usePointStyle

Constructor Details

LegendLabels

public LegendLabels()

Method Details

getBoxWidth

public Integer getBoxWidth()

See Also:

• setBoxWidth(Integer)

setBoxWidth

public LegendLabels setBoxWidth(Integer boxWidth)

Width of coloured box

Default 40

getFontSize

public Integer getFontSize()

See Also:

• setFontSize(Integer)

setFontSize

public LegendLabels setFontSize(Integer fontSize)

Font size inherited from global configuration

Default 12

getFontStyle

public FontStyle getFontStyle()

See Also:

• setFontStyle(FontStyle)

setFontStyle

public LegendLabels setFontStyle(FontStyle fontStyle)

Font style inherited from global configuration

Default "normal"

getFontColor

public Object getFontColor()

See Also:

• setFontColor(Object)

setFontColor

public LegendLabels setFontColor(Object fontColor)

Font color inherited from global configuration

Default "#666"

getFontFamily

public String getFontFamily()

See Also:

• setFontFamily(String)

setFontFamily

public LegendLabels setFontFamily(String fontFamily)

Font family inherited from global configuration

Default "'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"

getPadding

public Integer getPadding()

See Also:

• setPadding(Integer)

setPadding

public LegendLabels setPadding(Integer padding)

Padding between rows of colored boxes

Default 10

getGenerateLabels

public JavaScriptFunction getGenerateLabels()

See Also:

• setGenerateLabels(JavaScriptFunction)

setGenerateLabels

public LegendLabels setGenerateLabels(JavaScriptFunction generateLabels)

Generates legend items for each thing in the legend. Default implementation returns the text + styling for the color box. See Legend Item for details.

Default function(chart) { }

getUsePointStyle

public Boolean getUsePointStyle()

See Also:

• setUsePointStyle(Boolean)

setUsePointStyle

public LegendLabels setUsePointStyle(Boolean usePointStyle)

Label style will match corresponding point style (size is based on fontSize, boxWidth is not used in this case).

Default false