Class LineOptions
- java.lang.Object
-
- org.pepstock.charba.client.configuration.ConfigurationOptions
-
- org.pepstock.charba.client.configuration.ScalesOptions
-
- org.pepstock.charba.client.configuration.LineOptions
-
- All Implemented Interfaces:
HasAnimation
,ConfigurationElement
,AddHandlerEventHandler
,EventHandler
,RemoveHandlerEventHandler
- Direct Known Subclasses:
AreaOptions
,StackedLineOptions
,VerticalLineOptions
public class LineOptions extends ScalesOptions
Specific options for LINE chart. It contains all properties for this kind of chart.- Author:
- Andrea "Stock" Stocchero
-
-
Constructor Summary
Constructors Constructor Description LineOptions(IsChart chart, IsDefaultScaledOptions defaultValues)
Builds the object storing the chart instance and default values.
-
Method Summary
All Methods Instance Methods Concrete Methods Default Methods Modifier and Type Method Description IsChart
getChart()
Returns the chart instanceprotected T
getConfiguration()
Returns the configuration element.Decimation
getDecimation()
Returns the decimation plugin element.IndexAxis
getIndexAxis()
Returns the base axis for the dataset.ScalesOptions
getOptions()
Segment
getSegment()
Returns the segment element.default boolean
isShowLine()
Iffalse
, the lines between points are not drawn.default boolean
isSpanGaps()
If false,Double.NaN
data causes a break in the line.ChartEnvelop<NativeObject>
loadNativeObject(ChartEnvelop<NativeObject> envelop)
Returns the native object instance inside an envelop.
It can be called only fromorg.pepstock.charba.client
package.void
merge(NativeObjectContainer source, String property)
Merge a native object in the 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 in the options of chart.protected void
setConfiguration(T configuration)
void
setIndexAxis(IndexAxis indexAxis)
Sets the base axis for the dataset.
UseIndexAxis.Y
for vertical line.default void
setShowLine(boolean showLine)
Iffalse
, the lines between points are not drawn.default void
setSpanGaps(boolean spanGaps)
If false,Double.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.ScalesOptions
getAxisById, getScales
-
Methods inherited from class org.pepstock.charba.client.configuration.ConfigurationOptions
afterAxisConfigurationUpdate, afterConfigurationUpdate, beforeAxisConfigurationUpdate, beforeConfigurationUpdate, getAnimationContainer, getAspectRatio, getBackgroundColor, getBackgroundColorAsString, getBorderColor, getBorderColorAsString, getColor, getColorAsString, getDatasets, getDevicePixelRatio, getElements, getEvents, getFiller, getFont, getHover, getInteraction, getLayout, getLegend, getLocale, getPlugins, getResizeDelay, getSubtitle, getTitle, getTooltips, hasAxisClickHandlers, hasAxisEnterHandlers, hasAxisHoverHandlers, hasAxisLeaveHandlers, hasDatasetSelectionHandlers, hasSubtitleClickHandlers, hasSubtitleEnterHandlers, hasSubtitleLeaveHandlers, hasTitleClickHandlers, hasTitleEnterHandlers, hasTitleLeaveHandlers, isDestroyOnDetach, isDrawOnAttach, isMaintainAspectRatio, isResponsive, load, loadOptions, onAdd, onRemove, setAspectRatio, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setChartOptions, setColor, setColor, setDestroyOnDetach, setDevicePixelRatio, setDrawOnAttach, setEvents, setLocale, setMaintainAspectRatio, setResizeDelay, setResponsive
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.pepstock.charba.client.configuration.HasAnimation
getAnimation, getAnimations, getTransitions, isAnimationEnabled, setAnimationEnabled
-
-
-
-
Constructor Detail
-
LineOptions
public LineOptions(IsChart chart, IsDefaultScaledOptions defaultValues)
Builds the object storing the chart instance and default values.- Parameters:
chart
- chart instancedefaultValues
- defaults options of line chart
-
-
Method Detail
-
getDecimation
public Decimation getDecimation()
Returns the decimation plugin element.- Returns:
- the decimation plugin element
-
getSegment
public Segment getSegment()
Returns the segment element.- Returns:
- the segment element
-
getOptions
public final ScalesOptions getOptions()
-
setIndexAxis
public void setIndexAxis(IndexAxis indexAxis)
Sets the base axis for the dataset.
UseIndexAxis.Y
for vertical line.- Parameters:
indexAxis
- the base axis for the dataset
-
getIndexAxis
public IndexAxis getIndexAxis()
Returns the base axis for the dataset.- Returns:
- the base axis for the dataset
-
setShowLine
public default void setShowLine(boolean showLine)
Iffalse
, the lines between points are not drawn.- Parameters:
showLine
- iffalse
, the lines between points are not drawn.
-
isShowLine
public default boolean isShowLine()
Iffalse
, the lines between points are not drawn.- Returns:
- if
false
, the lines between points are not drawn.
-
setSpanGaps
public default void setSpanGaps(boolean spanGaps)
If false,Double.NaN
data causes a break in the line.- Parameters:
spanGaps
- If false,Double.NaN
data causes a break in the line.
-
isSpanGaps
public default boolean isSpanGaps()
If false,Double.NaN
data causes a break in the line.- Returns:
- If false,
Double.NaN
data causes a break in the line.
-
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 in the 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 in the options of chart.- Parameters:
source
- native object container to addproperty
- property name
-
toJSON
public final String toJSON()
Returns the JSON representation of the object.- Returns:
- the JSON representation of the object.
-
loadNativeObject
public final ChartEnvelop<NativeObject> loadNativeObject(ChartEnvelop<NativeObject> envelop)
Returns the native object instance inside an envelop.
It can be called only fromorg.pepstock.charba.client
package.- Parameters:
envelop
- envelop instance which will contain the native object- Returns:
- the envelop, passed as argument, loaded with the native object
-
getChart
public final IsChart getChart()
Returns the chart instance- Returns:
- the chart
-
-