org.pepstock.charba.client.configuration

Class ScatterOptions

java.lang.Object

org.pepstock.charba.client.configuration.ConfigurationOptions

org.pepstock.charba.client.configuration.ScatterOptions

All Implemented Interfaces:

ConfigurationElement

public class ScatterOptions
extends ConfigurationOptions

Specific options for SCATTER chart. It contains all properties for this kind of chart.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
ScatterOptions(IsChart chart, ChartOptions defaultValues) Builds the object storing the chart instance and default values.

Method Summary

Modifier and Type	Method and Description
IsChart	getChart() Returns the chart instance
protected T	getConfiguration() Returns the configuration element.
org.pepstock.charba.client.configuration.MultiScalesOptions	getOptions() Returns a options which will implements show lines and span gaps.
Scales	getScales() Returns the scales element.
default boolean	isShowLines() If false, the lines between points are not drawn.
default boolean	isSpanGaps() If false, NaN data causes a break in the line.
void	merge(NativeObjectContainer source, String property) Merge a native object into this one with a specific property name. This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration into options of chart.
static void	register(IsChart chart, org.pepstock.charba.client.configuration.IsEventProvider provider) Adds the event provider implementation as handlers of chart.
protected void	setConfiguration(T configuration)
default void	setShowLines(boolean showLine) If false, the lines between points are not drawn.
default void	setSpanGaps(boolean spanGaps) If false, NaN data causes a break in the line.
String	toJSON() Returns the JSON representation of the object.

Methods inherited from class org.pepstock.charba.client.configuration.ConfigurationOptions

getAnimation, getAspectRatio, getDevicePixelRatio, getElements, getEvents, getHover, getLayout, getLegend, getLegendCallback, getPlugins, getResponsiveAnimationDuration, getTitle, getTooltips, hasAxisClickHandlers, hasDatasetSelectionHandlers, hasTitleClickHandlers, isMaintainAspectRatio, isResponsive, load, onAdd, onRemove, setAspectRatio, setDevicePixelRatio, setEvents, setLegendCallback, setMaintainAspectRatio, setResponsive, setResponsiveAnimationDuration

Methods inherited from class java.lang.Object

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

Constructor Detail

ScatterOptions

public ScatterOptions(IsChart chart,
                      ChartOptions defaultValues)

Builds the object storing the chart instance and default values.

Parameters:

chart - chart instance

defaultValues - defaults options of scatter chart

Method Detail

getOptions

public final org.pepstock.charba.client.configuration.MultiScalesOptions getOptions()

Returns a options which will implements show lines and span gaps.

Returns:

a options instance

setShowLines

public void setShowLines(boolean showLine)

If false, the lines between points are not drawn.

Parameters:

showLine - If false, the lines between points are not drawn.

isShowLines

public boolean isShowLines()

If false, the lines between points are not drawn.

Returns:

If false, the lines between points are not drawn.

setSpanGaps

public void setSpanGaps(boolean spanGaps)

If false, NaN data causes a break in the line.

Parameters:

spanGaps - If false, NaN data causes a break in the line.

isSpanGaps

public boolean isSpanGaps()

If false, NaN data causes a break in the line.

Returns:

If false, NaN data causes a break in the line.

getScales

public Scales getScales()

Returns the scales element.

Returns:

the scales

register

public static void register(IsChart chart,
                            org.pepstock.charba.client.configuration.IsEventProvider provider)

Adds the event provider implementation as handlers of chart.

Parameters:

chart - chart instance

provider - event provider implmentation

setConfiguration

protected final void setConfiguration(T configuration)

Parameters:

configuration - the configuration to set

getConfiguration

protected final T getConfiguration()

Returns the configuration element.

Returns:

the configuration element.

merge

public final void merge(NativeObjectContainer source,
                        String property)

Merge a native object into this one with a specific property name.
This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration into options of chart.

Parameters:

source - native object container to add

property - property name

toJSON

public final String toJSON()

Returns the JSON representation of the object.

Returns:

the JSON representation of the object.

getChart

public final IsChart getChart()

Returns the chart instance

Returns:

the chart