be.ceau.chart.options

Class Options<T extends Options<T>>

java.lang.Object

be.ceau.chart.options.Options<T>

Direct Known Subclasses:

BarOptions, BubbleOptions, DoughnutOptions, LineOptions, PieOptions, PolarOptions, RadarOptions

public class Options<T extends Options<T>>
extends Object

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Modifier and Type	Method and Description
Animation<?>	getAnimation()
Set<Event>	getEvents()
Hover	getHover()
Layout	getLayout()
Legend	getLegend()
JavaScriptFunction	getLegendCallback()
Boolean	getMaintainAspectRatio()
JavaScriptFunction	getOnClick()
JavaScriptFunction	getOnResize()
Boolean	getResponsive()
Integer	getResponsiveAnimationDuration()
Title	getTitle()
Tooltips	getTooltips()
T	setAnimation(Animation<?> animation) The following animation options are available.
T	setEvents(Collection<Event> events) Default ["mousemove", "mouseout", "click", "touchstart", "touchmove", "touchend"] Events that the chart should listen to for tooltips and hovering
T	setHover(Hover hover) The hover configuration is passed into the options.hover namespace.
T	setLayout(Layout layout)
T	setLegend(Legend legend) The legend configuration is passed into the options.legend namespace.
T	setLegendCallback(JavaScriptFunction legendCallback) Default function (chart) { } Function to generate a legend.
T	setMaintainAspectRatio(Boolean maintainAspectRatio) Default true Maintain the original canvas aspect ratio (width / height) when resizing
T	setOnClick(JavaScriptFunction onClick) Default null Called if the event is of type 'mouseup' or 'click'.
T	setOnResize(JavaScriptFunction onResize) Default null Called when a resize occurs.
T	setResponsive(Boolean responsive) Default true Resizes when the canvas container does.
T	setResponsiveAnimationDuration(Integer responsiveAnimationDuration) Default 0 Duration in milliseconds it takes to animate to new size after a resize event.
T	setTitle(Title title) The title configuration is passed into the options.title namespace.
T	setTooltips(Tooltips tooltips) The tooltip label configuration is nested below the tooltip configuration using the callbacks key.

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options()

Method Detail

getResponsive

public Boolean getResponsive()

See Also:

setResponsive(Boolean)

setResponsive

public T setResponsive(Boolean responsive)

Default true Resizes when the canvas container does.

getResponsiveAnimationDuration

public Integer getResponsiveAnimationDuration()

See Also:

setResponsiveAnimationDuration(Integer)

setResponsiveAnimationDuration

public T setResponsiveAnimationDuration(Integer responsiveAnimationDuration)

Default 0 Duration in milliseconds it takes to animate to new size after a resize event.

getMaintainAspectRatio

public Boolean getMaintainAspectRatio()

See Also:

setMaintainAspectRatio(Boolean)

setMaintainAspectRatio

public T setMaintainAspectRatio(Boolean maintainAspectRatio)

Default true Maintain the original canvas aspect ratio (width / height) when resizing

getEvents

public Set<Event> getEvents()

See Also:

setEvents(Collection)

setEvents

public T setEvents(Collection<Event> events)

Default ["mousemove", "mouseout", "click", "touchstart", "touchmove", "touchend"] Events that the chart should listen to for tooltips and hovering

getOnClick

public JavaScriptFunction getOnClick()

See Also:

setOnClick(JavaScriptFunction)

setOnClick

public T setOnClick(JavaScriptFunction onClick)

Default null Called if the event is of type 'mouseup' or 'click'. Called in the context of the chart and passed an array of active arcElements

getLegendCallback

public JavaScriptFunction getLegendCallback()

See Also:

setLegendCallback(JavaScriptFunction)

setLegendCallback

public T setLegendCallback(JavaScriptFunction legendCallback)

Default function (chart) { } Function to generate a legend. Receives the chart object to generate a legend from. Default implementation returns an HTML string.

getOnResize

public JavaScriptFunction getOnResize()

See Also:

setOnResize(JavaScriptFunction)

setOnResize

public T setOnResize(JavaScriptFunction onResize)

Default null Called when a resize occurs. Gets passed two arguemnts: the chart instance and the new size.

getTitle

public Title getTitle()

See Also:

setTitle(Title)

setTitle

public T setTitle(Title title)

The title configuration is passed into the options.title namespace. The global options for the chart title is defined in Chart.defaults.global.title.

getLegend

public Legend getLegend()

See Also:

setLegend(Legend)

setLegend

public T setLegend(Legend legend)

The legend configuration is passed into the options.legend namespace. The global options for the chart legend is defined in Chart.defaults.global.legend.

getTooltips

public Tooltips getTooltips()

See Also:

setTooltips(Tooltips)

setTooltips

public T setTooltips(Tooltips tooltips)

The tooltip label configuration is nested below the tooltip configuration using the callbacks key. The tooltip has the following callbacks for providing text. For all functions, 'this' will be the tooltip object created from the Chart.Tooltip constructor. All functions are called with the same arguments: a tooltip item and the data object passed to the chart. All functions must return either a string or an array of strings. Arrays of strings are treated as multiple lines of text.

getHover

public Hover getHover()

See Also:

setHover(Hover)

setHover

public T setHover(Hover hover)

The hover configuration is passed into the options.hover namespace. The global hover configuration is at Chart.defaults.global.hover.

getAnimation

public Animation<?> getAnimation()

See Also:

setAnimation(Animation)

setAnimation

public T setAnimation(Animation<?> animation)

The following animation options are available. The global options for are defined in Chart.defaults.global.animation.

getLayout

public Layout getLayout()

Returns:

Layout instance or null

setLayout

public T setLayout(Layout layout)

Parameters:

layout - Layout instance or null

Returns:

this instance for chaining